Para execução do projeto siga os passos abaixo:
- Edite o arquivo .env.example com as informações de seu ambiente.
- Para executar a aplicação, com o nodeJS e o mongodb instalado no seu sistema vá até a pasta raiz do projeto e digite os comandos:
npm install
andnpm start
- Para rodar os testes unitários digite o comando:
npm run test
- E para gerar o relatório de cobertura de testes, execute o comando abaixo:
npm coverage
Uma demonstração da API funcionando pode ser encontrado no endereço https://compasso-desafio.herokuapp.com/ com os seguintes endPoints :
- GET /cidade/
- GET /cidade/nome/:nome
- GET /cidade/estado/:estado
- POST /cidade/
- GET /cliente/
- GET /cliente/nome/:nome
- GET /cliente/id/:id
- POST /cliente/
- PUT /cliente/:id
- DELETE /cliente/:id