express boilerplate

Node.js, express.js kesselplatte mit sequelize orm

Ein Template-Repository-Boilerplate zum Erstellen von RESTful-APIs mit Node.js, Express.js und Folgen- und Folgen-CLI-Unterstützung. Diese Vorlage enthält gängige featurespezifische Zweige, die bei Bedarf in Ihr Repository zusammengefasst werden können.

Voraussetzungen

• Installieren Sie node.js Version 18.16.1
• Installieren Sie MySQL 8
• Erstellen Sie die in MySQL benannte Datenbank

Erste Schritte

• Erstellen Sie Repository aus der Vorlage

• Erstellen Sie .Env -Datei im Stammprojekt und füllen Sie sie mit Werten als Referenzprüfung.

 cd <project_name>
 cp .env.example .env

• Abhängigkeiten installieren

 npm install

• Migrationen laufen

 npx sequelize db:migrate

• Datenbank mit Sämaschinen füllen

 npx sequelize db:seed:all

• Projekt in Entwicklungsummen starten

 npm run dev

• Projekt starten in der Produktionsumgebung

 npm start

Navigieren Sie zu http://localhost:4040

Es Lint und schöner

• Überprüfen Sie, ob die Formatierung mit den neueren Regeln übereinstimmt, indem Sie Folgendes verwenden:

 npm run format

• Erzwingen Sie die Formatierung mit diesem Befehl:

 npm run format:fix

• FININT IHRE CODE mit:

 npm run lint

• Erzwingen Sie die Linie mit diesem Befehl:

 npm run lint:fix

Zweige

Führen Sie Filialen zusammen, um die unten aufgeführten Funktionen zu implementieren

Merkmale

• Swagger Docs: feat/swagger-docs
• Twilio SMS: feat/twilio-SMS
• SENDGRID EMAI: feat/sendgrid-mail
• AWS S3 Bucket: feat/AWS-S3-bucket
• Sockets: feat/sockets
• Knotencron: feat/node-cron

CI (Fortsetzung der Integration)

• Scherzintegrationstests (Git-Aktionen): ci/jest-test

Notiz

Wenn Sie das Repository ohne Verzweigungen erstellt haben oder eine bestimmte Funktionszweig erhalten möchten, ohne alle Zweige zu erhalten, können Sie einen bestimmten Zweig abrufen, indem Sie die folgenden Befehle ausführen:

 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>

Durch Ausführen der obigen Befehle, die spezifische Filiale zu Ihrem Repo gedrückt werden.