express boilerplate

Node.js, Express.js Boilerplate dengan ORM Sequellize

Boilerplate repositori template untuk membangun API REST. Menggunakan Node.js, Express.js, dan Sequelize dan dengan dukungan sekuelisasi-CLI. Template ini mencakup cabang khusus fitur umum untuk bergabung ke dalam repositori Anda jika diperlukan.

Prasyarat

• Instal Node.js Versi 18.16.1
• Instal MySQL 8
• Buat database yang disebutkan di MySQL

Memulai

• Buat repositori dari template

• Buat file .env pada root proyek dan mengisinya dengan nilai, untuk pemeriksaan referensi file .envexample pada root proyek

 cd <project_name>
 cp .env.example .env

• Instal dependensi

 npm install

• Jalankan migrasi

 npx sequelize db:migrate

• Mengisi database dengan seeders

 npx sequelize db:seed:all

• Mulai Proyek dalam Pengembangan Env

 npm run dev

• Mulai Proyek dalam Produksi Env

 npm start

Arahkan ke http://localhost:4040

Es serat dan lebih cantik

• Periksa apakah pemformatan cocok dengan aturan yang lebih cantik dengan menggunakan:

 npm run format

• Paksa pemformatan dengan menggunakan perintah ini:

 npm run format:fix

• Serat kode Anda dengan:

 npm run lint

• Memaksa berbaris dengan menggunakan perintah ini:

 npm run lint:fix

Cabang fitur

Gabungkan cabang untuk mengimplementasikan fitur yang tercantum di bawah ini

Fitur

• Dokumen Swagger: feat/swagger-docs
• Twilio SMS: feat/twilio-SMS
• Sendgrid Emai: feat/sendgrid-mail
• AWS S3 Bucket: feat/AWS-S3-bucket
• Soket: feat/sockets
• Node Cron: feat/node-cron

CI (terus integrasi)

• Tes Integrasi Jest (Tindakan GIT): ci/jest-test

Catatan

Jika Anda telah membuat repositori tanpa cabang, atau Anda ingin mendapatkan cabang fitur tertentu tanpa mendapatkan semua cabang maka Anda dapat mengambil cabang tertentu dengan menjalankan perintah di bawah ini:

 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>

Dengan menjalankan perintah di atas yang akan didorong oleh Cabang Spesfic ke repo Anda.