express boilerplate

node.js、express.js ormを備えたvoilerplate

Node.js、Express.js、およびSequelize-CLIサポートを使用して、RESTFUL APIを構築するためのテンプレートリポジトリボイラープレート。このテンプレートには、必要に応じてリポジトリに融合するための一般的な機能固有の分岐が含まれています。

前提条件

• 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

• 開発中のプロジェクトを開始end

 npm run dev

• プロダクションでプロジェクトを開始します

 npm start

http://localhost:4040に移動します

eslintとよりきれい

• フォーマットが次のことを使用して、きれいなルールと一致するかどうかを確認します。

 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
• ノードクロン： feat/node-cron

CI（統合を継続）

• JEST統合テスト（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 Branchがリポジトリにプッシュされます。