express boilerplate

node.js，带有semelize orm的express.js样板

使用node.js，express.js构建RESTFUL API的模板存储库样板，并通过semelize-cli支持进行续集。该模板包括特定于功能的分支，如果需要，可以合并到您的存储库中。

先决条件

• 安装Node.js版本18.16.1
• 安装mysql 8
• 创建在MySQL中命名的数据库

入门

• 从模板创建存储库

• 在项目的根部创建.ENV文件并用值填充它，以供参考检查。

 cd <project_name>
 cp .env.example .env

• 安装依赖项

 npm install

• 运行迁移

 npx sequelize db:migrate

• 带播种机的填充数据库

 npx sequelize db:seed:all

• 在开发环境中启动项目

 npm run dev

• 在生产env中启动项目

 npm start

导航到http://localhost:4040

es棉又漂亮

• 通过使用以下方式检查格式是否与漂亮的规则匹配：

 npm run format

• 通过使用此命令强制格式化：

 npm run format:fix

• 用：用：

 npm run lint

• 使用此命令强制覆盖：

 npm run lint:fix

特征分支

合并分支以实现下面列出的功能

特征

• Swagger Docs： feat/swagger-docs
• Twilio SMS： feat/twilio-SMS
• sendgrid emai： feat/sendgrid-mail
• AWS S3存储桶： feat/AWS-S3-bucket
• 插座： feat/sockets
• 节点cron： feat/node-cron

CI（继续集成）

• 开玩笑的集成测试（GIT动作）： ci/jest-test

笔记

如果您在没有分支的情况下创建了存储库，或者您想获得任何特定的功能分支，而无需获得所有分支，则可以通过运行以下命令来获取特定分支：

 git remote add template <template_repository_url>
git fetch template <template_repo_branch_name>
git checkout <template_repo_branch_name>
git push origin <template_repo_branch_name>

通过运行上述命令，Specfic分支将推到您的存储库。