Para instalar o projeto e rodar em ambiente localhost, é necessário atender às seguintes exigências
- Ter node 10 instalado.
Será necessário a instalação de MongoDB
Após instalar o Node e o MongoDB, navegar até a pasta do projeto e rodar:
npm install
O projeto foi criado sobre o Framework Express
Para Iniciar o projeto
cd src/
npm start
A API foi toda construída com a filosofia RESTFUL. Para uma documentação detalhada, com exemplos de uso em PHP, Javascript, cURL, etc, basta clicar aqui.
Na documentação acima é possível ver todos os métodos com exemplos em PHP, Javascript, cURL, etc. Tanto HEADERS como BODY dos requests e roda-los automaticamente no Postman.