noomi-cli

noomi 客户端命令工具，可一键生成项目结构。

前置安装

1. 安装node并设置好node和npm环境变量，否则可能会报找不到npm的异常；
2. 安装noomi-cli，输入 npm install noomi-cli -g。

用法

1. 新建一个目录，如 my-firstapp；
2. 命令行模式到该目录下；
3. 输入 noomi create my-firstapp 或者noomi create my-firstapp -n，进行noomi环境安装和项目新建，某些系统可能需要管理员权限执行(sudo)。
4. 输入 noomi create my-firstapp -c，通过淘宝源安装noomi并新建项目，noomi create -h 可以看如何安装淘宝源。

运行

方法一： 使用方法：

1. cd 项目名 进入到项目目录
2. 在目录下运行 npm run build ，编译ts文件；
3. 运行npm run start，启动应用。

说明：此方式只启动服务器，不打开浏览器，也不支持热重载，可选择在应用启动后，在浏览器中输入localhost:3000/hello访问，此时输出{"result":"Hello Router! Hello Service! Hello Dao!"}，可选择关闭启动进程，在控制台输入noomi start 端口号(默认3000) -l 启动服务器，此时支持热重载。

方法二：

1. cd 项目名 进入到项目目录
2. 在目录下运行 npm run build ，编译ts文件；
3. 运行npm run serve，启动应用。

说明：此方式启动服务器后会打开浏览器，但不支持热重载，可选择在应用启动后，在浏览器中输入localhost:3000/hello访问，此时输出{"result":"Hello Router! Hello Service! Hello Dao!"}，可选择关闭启动进程，在控制台输入noomi start 端口号(默认3000) -l 启动服务器，此时支持热重载。

方法三：

1. cd 项目名 进入到项目目录
2. 在目录下运行 npm run build ，编译ts文件；
3. 运行npm run server，启动应用。

说明：此方式启动服务器后会打开浏览器，且支持热重载。 切换到浏览器，输入localhost:3000/hello，输出{"result":"Hello Router! Hello Service! Hello Dao!"}

项目目录说明

• .vscode: vscode配置
  • launch文件: vscode启动文件
• config: noomi 配置文件
  • noomi.json: noomi 主配置文件
  • database: 数据源配置文件目录
    • mssql.json: mssql配置文件
    • mysql.json: mysql配置文件
    • oracle.json: oracle配置文件
    • relaen.json: relaen配置文件
    • sequelize.json: sequelize配置文件
    • typeorm.json: typeorm
  • redis.json: redis配置文件
  • security.json: 安全框架配置文件
  • web.json: web配置文件
• module: 核心模块
  • dao dao层相关模块
    • dao.hello.ts 数据访问文件
  • router 路由相关模块
    • route.hello.ts: 路由文件
  • service 业务层相关模块
    • service.hello.ts: 业务文件
• web: web静态资源文件
  • index.html: web入口文件
• test: 项目测试目录
  • test.hello.ts: 项目测试文件
• upload: 文件上传目录
  • test.txt: 文件上传测试文件
• app.ts: 项目启动文件
• .gitignore: gitignore配置文件
• package.json: package配置文件
• package-lock.json: package-lock配置文件
• README.md: 项目说明文件
• tsconfig.json: typescript配置文件

版本说明

1.0.7

1. 根据noomi升级更改config文件；
2. 取消内置sudo，安装时，由用户手动添加sudo。

脚手架更新部分

1. 用户无需关心是否安装typescript和ts-node，noomi-cli会自动检测，未安装则会自动安装；
2. noomi框架需要node14版本以上支持，noomi-cli会检测用户的node版本，版本低于14时会停止创建noomi项目；
3. 修改模板中Inject依赖注入失败问题；
4. config文件夹新增relaen.json配置文件，用于配置relaen的orm框架；
5. 新增log4js依赖，用于处理日志依赖查找失败问题；
6. 新增热重载功能，用户项目修改后无需自行重新启动项目，noomi-cli将自动监听用户文件变化，变化时自动编译和自动重启项目；
7. 新增.gitignore文件处理git上传下载问题；
8. 新增upload文件夹，用于存放上传和下载时的文件，具体路径配置可通过config文件下web.json进行修改；
9. 新增test文件夹，用于用户测试路由接口；
10. 新增README.md文件，用于项目说明；
11. 修改noomi项目创建指令，原先为noomi-cli -n和noomi-cli -c，现为noomi create 项目名 -n（-n可不写）或者noomi create 项目名 -c；
12. 新增指令noomi start 端口号，用启动项目，此时不支持热更新，支持热更新需添加参数-l；
13. 项目初始化提示信息优化；