创建项目

通过 @gem-mine/cli 创建项目

  1. # 安装 cli 工具
  2. npm i @gem-mine/cli -g
  4. # 创建项目
  5. gmc create my-project
  6. # 选择包管理器
  7. # 是否接入 UC 鉴权
  9. # 进入项目
  10. cd my-project
  12. # 本地开发
  13. npm start
  15. # 构建上线
  16. npm run start:prod

了解目录结构

目录命名一般采用名词本身形式，不采用 复数形式。
image.png
这里做下大致介绍：

  • dist： 文件生成目录
  • log： 日志
  • public： 静态文件
  • src： 源码
    • config：参数配置
    • engine 模板引擎
    • exceptionFilter：异常过滤器
    • guard：守卫
    • middleware：中间件
    • module：模块
    • util：工具函数
    • app.module.ts：应用主模块
    • main.js 应用入口文件
  • test： 测试代码
  • view： 模板文件
  • .env： 环境变量配置
  • .eslintrc.js： eslint 配置
  • .gitignore： git ignore 配置
  • .prettierrc： prettier 配置
  • Dockerfile： 镜像生成配置
  • nest-cli.json： nest cli 配置
  • tsconfig.json： ts 编译配置