NOME DO REPOSITÓRIO/SERVIÇO AQUI
[BREVE RESUMO DO QUE SE TRATA ESSA CODEBASE, DE FORMA OBJETIVA E SIMPLES DE ENTENDER]
Indice da Documentação
- Responsáveis
- Tecnologias Utilizadas
- Padrões e Políticas dessa codebase
- Endpoints e Acessos
- Documentação API
Instalação e Setup Local
[COLOCAR TODA CONFIGURAÇÃO NECESSÁRIA QUE ESSE SERVIÇO NECESSITA PARA SER RODADO LOCALMENTE AQUI]
-
Clone o repositório
git clone https://github.com/company/todo-api-clean-architecture-boilerplate
-
Instale as dependências utilizando:
npm install
-
Defina as variáveis de ambiente em um novo arquivo chamado
.env
, conforme o arquivo.env.example
- Peça para seu tech-lead ou colegas de trabalho te mandaram uma cópia do .env deles, para execução local, caso necessário
-
Suba os serviços docker necessários:
sudo docker-compose up -d
-
Pegue o IP address do serviço postgres do docker:
docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' todo_postgres
-
Atualize o servidor da variável de ambiente DATABASE_URL no arquivo
.env
, como no exemplo abaixo:DATABASE_URL="postgresql://postgres:postgres@172.29.0.2:5432/todo_api?schema=public"
-
Gere o client do prisma:
npx prisma generate
-
Rode as migrations do Prisma:
npx prisma migrate dev
-
Suba o servidor localmente:
npm run dev
-
Cheque o Prettier e o ESLint antes de enviar uma PR:
npm run precommit
- Cheque também se todos os testes continuam passando, antes de enviar uma PR:
npm run test
- Lembre-se de verificar outros comandos úteis no arquivo
package.json