快速开始

环境准备

  • 操作系统:支持 macOS,Linux,Windows
  • 运行环境:支持 Node.js 8.x 及以上版本。

初始化工程

安装 Uma 命令

$ npm i @umajs/cli -g

$ uma
or
$ umajs
1
2
3
4
5

卸载旧版本命令

npm uninstall @umajs/cli -g
1

使用

查看版本

uma -V
1

初始化工程

uma project [projectName]
1

初始化目录结构

cd [projectname]
npm install
npm start
http://127.0.0.1:8058
1
2
3
4

项目结构

├── src
|   ├── app.ts  // 入口
|   ├── aspect      // 切面
|   |   ├── index.aspect.ts
|   ├── config      // 配置文件目录
|   |   ├──plugin.config.ts
|   ├── controller  // 控制器目录
|   |   ├──index.controller.ts
|   ├── plugins     //插件
|   |   ├── error-handler
|   |   |   ├── index.ts
|   ├── service     //服务
|   |   ├── test.service.ts
├── static      //静态目录
|   ├── index.html
├── views       //模板目录
|   ├── index.html
├── .eslintrc.js
├── README.md
├── package.json
├── tsconfig.json   // ts配置文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

保留目录

src 中 config、controller、plugins 三个目录为保留目录

服务部署

生产环境构建

生产环境部署时,将会把 typescript 编译成 js 后运行。默认构建后 js 源码目录是 app

构建并启动命令

npm run build   // 会自动先执行lint校验和build命令,然后才启动生产环境代码
1

如何区分多环境配置

参考 config

文档和社区