Para rodar o projeto localmente será necessário:
- Instalar as dependências:
npm i
-
Copiar as variáveis do
.env.example
para.env
com uma configuração de banco de dados postgresql -
Iniciar o servidor com o comando:
npm run start
É possível iniciar o servidor com hot reload utilizando o comando:
npm run dev
O repositório também conta com testes unitários e de integração. O objetivo deste repositório é ser didático, portanto, caso queira rodar os testes, existem estes comandos:
# Roda os testes unitários:
## Testa as funcionalidades de domínio e casos de uso sem a influência de bibliotecas externas;
npm test
# Roda os testes de integração:
## Testa operações partindo da requisição do usuário (denominado aqui como endToEnd).
npm run test:int
Importante mencionar que para os testes de integração funcionarem corretamente, é necessário criar um arquivo
.env.testing
a partir do.env.example
. Pois o jest irá buscar as variáveis de ambiente deste arquivo. Você pode utilizar as mesmas variáveis do.env
, mas tenha em mente que os testes de integração irão limpar os dados do banco ao terminar os testes.
-
Ádrian de Freitas Ferreira <adrian.fr.fe@gmail.com>
-
Henrique Biasibetti Farias <henrique.biasibetti@gmail.com>