deepexi-eggjs

CHANGELOG

如何运行

本地开发

$ npm i
$ npm run dev
$ open http://localhost:8080/deepexi-eggjs

swagger地址：http://localhost:8080/swagger-ui.html
swagger json：http://127.0.0.1:8080/swagger-doc

部署

进程启动

$ npm i
$ npm start
$ npm stop

容器启动

$ sh start-code.sh [-bl]

• -b: 是否从本地构建镜像
• -l: 是否在启动后输出容器日志

支持的环境变量

• APP_NAME: 指定镜像和容器的名称，默认为deepexi-eggjs
• VERSION: 指定镜像tag，默认为1.0.0
• ENV: 指定egg应用运行环境，默认为prod
• WORKERS: 指定egg应用worker数量，默认为4

如果需要自定义启动命令，可以自行修改run.sh。

其它指令

• 使用 npm run lint [--fix] 检查你的代码风格
• 使用 npm test 执行单元测试
• 使用 npm run ci 分析代码覆盖率
• 使用 npm run commit 通过交互模式提交代码
• 使用 npm run release 根据提交记录自动调整版本并生成相应的CHANGELOG
• 使用 npm run autod 自动检查依赖升级，更多细节查看autod

开发参考

override.js

项目提供了override.js文件供应用启动时读取并对配置进行覆写。

主要应用场景是在应用部署的时候经常会有一些配置需要通过启动命令传入（如数据库配置、eureka server配置等），如果将这部分配置都抽取为环境变量将会非常麻烦（尤其是在通过docker运行的时候）。这时可以考虑通过修改override.js文件来进行统一的配置覆写。

commit规范

此项目使用commitlint控制commit规范，默认采用规则@commitlint/config-conventional，在进行你的第一次提交之前请先仔细阅读此规范。

你也可以通过commitlint.config.js来修改规则。