kaiou-cli

Introduction

Tool for quickly and simply build umi3 project

Usage

install kaiou-cli

npm i -g kaiou-cli

choose install

or

type project info and wait project init, cd the project, and run yarn or npm i install depdences.

Template Directory

Directory

├── config/
    ├── config.ts                  // umi 配置，同 .umirc.js，二选一
├── dist/                          // 默认的 build 输出目录
├── mock/                          // mock 文件所在目录，基于 express
├── public/                        // 全局相对路径文件
└── src/                           // 源码目录，可选
    ├── .umi/                      // dev 临时目录，需添加到 .gitignore
    ├── hooks/                     // 全局共用自定义hook
    ├── assets/                    // 静态文件
    ├── components/                // 全局共用组件
    ├── layouts/index.tsx          // 全局入口文件
    ├── models/                    // 全局models文件，存放全局共用数据store
    ├── pages/                     // 页面目录，业务组件
        ├── histroy-records/       // 历史记录-业务模块
            ├── components/        // 历史记录-局部公共组件
            ├── models/            // 历史记录-局部models，存放histroy-records的store
            ├── services/          // 历史记录-局部services，存放histroy-records的接口
            ├── index.tsx          // 业务组件index
            ├── page.tsx           // 业务组件page
            ├── _layout.tsx        // 局部入口文件,约定式路由时，pages下有_layout会优先经过_layout组件
        ├── 404.ts                 // 404 页面
    ├── services/                  // 全局services文件，存放全局公共接口
    ├── utils/                     // 全局工具类
        ├── request.ts             // ajax请求库封装
    ├── global.css                 // 约定的全局样式文件，自动引入，也可以用 global.less
    ├── global.ts                  // 约定的全局Js文件，自动引入，可以在这里加入 polyfill
    ├── app.ts                     // 运行时配置文件,getInitialState方法里请求接口，暴露初始数据
├── typings.d.ts                   // 定义全局常量和接口变量           
├── .umirc.js                      // umi 配置，同 config/config.js，二选一
├── .env                           // 环境变量
└── package.json