Template de Node com Fastify

Este projeto tem como proposta, ser um template "completo" para iniciar projetos para produção, com: Swagger, Banco de Dados, Lint, ORM entre outras coisas já configuradas para você apenas colocar a mão nas regras de negócio definidas nas suas tasks.

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• Node.js >= 16.15.0
• Yarn >= 1.22.18
• Docker >= 20.10.16
• Docker Compose >= 2.7.0

☕ Configurando variáveis de ambiente

Crie a variável de ambiente .env, usando o modelo .env.example, com o seguinte comando (se vc user unix) no terminal:

cat .env.example >> .env

🐳 Subindo banco de dados com docker compose

Para criar as tabelas no banco de dados, execute no terminal:

docker compose up -d

🚀 Instalando as depedências

Para instalar os pacotes de depedências, execute no terminal:

yarn install

🎲 Migrations de banco de dados

Para criar as tabelas no banco de dados, execute no terminal:

yarn migrate:run

Para deletar as tabelas no banco de dados, execute no terminal:

yarn migrate:reset

🏗 Iniciando o projeto para dev

yarn start

🃏 Rodando testes do projeto

yarn test

📫 Contribuindo o projeto

Para contribuir com o projeto, siga estas etapas:

1. Faça o fork deste repositório.
2. Crie um branch a partir da develop: git checkout -b <nome_branch>.
3. Faça suas alterações e confirme-as usando conventional commits : git commit -m feat: '<mensagem_commit>'
4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
5. Crie o pull request.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

😄 Toda contriuição é bem-vinda

📝 Licença

Esse projeto está sob licença MIT.

⬆ Voltar ao topo