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分支將推到您的存儲庫。