express boilerplate

Node.js, express.js boilerplate с продолжением ORM

Шаблон репозитория шаблон для создания RESTFUL API с использованием NODE.JS, Express.js, а также продолжения и с поддержкой Scelize-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

• Start Project in Development Env

 npm run dev

• Start Project в производстве Env

 npm start

Перейдите к http://localhost:4040

Es Lint и красивее

• Проверьте, соответствует ли форматирование правил красителя, используя:

 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 Bucket: feat/AWS-S3-bucket
• Главы: feat/sockets
• Узел Cron: 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>

Запустив приведенные выше команды, которые специфическая ветка будет выдвинута на ваше репо.