项目目录结构

12003

1. JianghuJS项目结构

  1. ├── app
  2. ├── common # 项目的常用工具、静态方法等
  3. ├── constant # 常量
  4. ├── constant.js
  5. └── error.js
  6. ├── controller # 对外暴露接口
  7. ├── public # 静态资源目录
  8. ├── schedule # 定时任务; 参考https://www.eggjs.org/zh-CN/basics/schedule
  9. ├── service # 应用协议service目录
  10. └── view # 页面存放目录
  11. ├── config # egg config
  12. ├── config.default.js # default config
  13. ├── config.local.js # npm run dev 时使用的 config
  14. ├── config.prod.js # npm run start 时使用的 config
  15. ├── config.unittest.js # npm run test 时使用的 config
  16. └── plugin.js # egg插件配置
  17. ├── app.js # 自定义启动时的初始化工作
  18. ├── jsconfig.json
  19. ├── package.json
  20. ├── sql # sql文件
  21. └── init.sql
  22. └── upload # 文件的保存路径(文件上传业务)

2、每一项目录的说明

  • app:应用程序的主要代码目录
    • common:存放项目的常用工具、静态方法等
    • constant:存放常量定义
      • constant.js:常量定义文件
      • error.js:错误信息定义文件
    • controller:存放对外暴露的接口的控制器
    • public:静态资源目录
    • schedule:存放定时任务
    • service:存放应用协议的 service 目录
    • view:存放页面的目录
  • config:存放配置文件
    • config.default.js:默认配置文件
    • config.local.js:用于 npm run dev 时使用的配置文件
    • config.prod.js:用于 npm run start 时使用的配置文件
    • config.unittest.js:用于 npm run test 时使用的配置文件
    • plugin.js:插件配置文件
  • app.js:自定义启动时的初始化工作的入口文件
  • jsconfig.json:用于配置 JavaScript 项目的语法检查、智能感知等相关设置的文件
  • package.json:项目的依赖和配置文件
  • sql:存放 SQL 文件
  • init.sql:初始化 SQL 文件
  • upload:上传文件的目录