express boilerplate

NODE.JS, EXPRESS.JS Plate-plaque avec séquelle ORM

Un chauffeur de référentiel de modèle pour la construction d'API RESTful à l'aide de Node.js, Express.js, et séquentie et avec le support séqueliste-CLI. Ce modèle comprend des branches communes spécifiques aux fonctionnalités pour fusionner dans votre référentiel si nécessaire.

Pré-requis

• Installer Node.js Version 18.16.1
• Installer mysql 8
• Créer une base de données nommée dans MySQL

Commencer

• Créer un référentiel à partir du modèle

• Créez un fichier .env sur la racine du projet et remplissez-le de valeurs, pour vérifier la référence .Envexample Fichier sur la racine du projet

 cd <project_name>
 cp .env.example .env

• Installer des dépendances

 npm install

• Exécuter des migrations

 npx sequelize db:migrate

• Base de données peupler avec les semers

 npx sequelize db:seed:all

• Démarrer le projet dans le développement Env

 npm run dev

• Démarrer le projet dans la production Env

 npm start

Accédez à http://localhost:4040

Es Lint et plus joli

• Vérifiez si le formatage correspond aux règles des plus jolies en utilisant:

 npm run format

• Forcer le formatage en utilisant cette commande:

 npm run format:fix

• Lint votre code avec:

 npm run lint

• Forcez la lie en utilisant cette commande:

 npm run lint:fix

Branches de fonctionnalités

Fusionner les succursales pour implémenter les fonctionnalités énumérées ci-dessous

Caractéristiques

• Swagger Docs: feat/swagger-docs
• Twilio SMS: feat/twilio-SMS
• SendGrid Emai: feat/sendgrid-mail
• Seau AWS S3: feat/AWS-S3-bucket
• Sockets: feat/sockets
• Node Cron: feat/node-cron

CI (continue l'intégration)

• Tests d'intégration de la plaisanterie (actions GIT): ci/jest-test

Note

Si vous avez créé le référentiel sans branches, ou si vous souhaitez obtenir une branche de fonctionnalité spécifique sans obtenir toutes les branches, vous pouvez récupérer une branche spécifique en exécutant les commandes ci-dessous:

 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>

En exécutant les commandes ci-dessus que SpecFing Branch a poussé vers votre dépôt.