express boilerplate

Node.js, Express.js Boilerplate com sequelizar ORM

Um caldeira de repositório de modelo para criar APIs RESTful usando Node.js, Express.js e Sequelizar e com suporte sequelize-cli. Este modelo inclui ramificações comuns específicas de recursos para se fundir no seu repositório, se necessário.

Pré-requisitos

• Instale o node.js versão 18.16.1
• Instale o MySQL 8
• Crie banco de dados nomeado em MySQL

Começando

• Crie repositório do modelo

• Crie um arquivo .env na raiz do projeto e preencha -o com valores, para verificação de referência .ENVEXAMPLEM FILE na raiz do projeto

 cd <project_name>
 cp .env.example .env

• Instalar dependências

 npm install

• Executar migrações

 npx sequelize db:migrate

• Preencher o banco de dados com semeres

 npx sequelize db:seed:all

• Iniciar o projeto em desenvolvimento Env

 npm run dev

• Iniciar o projeto em produção Env

 npm start

Navegue para http://localhost:4040

Es fiapos e mais bonitos

• Verifique se a formatação corresponde às regras do mais bonito usando:

 npm run format

• Forçar a formatação usando este comando:

 npm run format:fix

• Lint seu código com:

 npm run lint

• Forçar o linhagem usando este comando:

 npm run lint:fix

Ramificações de recursos

Merge ramificações para implementar os recursos listados abaixo

Características

• 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
• Node Cron: feat/node-cron

CI (continua a integração)

• Testes de integração de jest (Ações Git): ci/jest-test

Observação

Se você criou o repositório sem galhos, ou deseja obter qualquer ramo de recursos específicos sem obter todas as filiais, poderá buscar uma filial específica executando os comandos abaixo:

 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>

Executando os comandos acima que o Specfic Branch levará para o seu repositório.