O NPS-API é uma API Restful para Net Promoter Score.
Aplicação web construída na trilha NodeJS da Next Level Week distribuída pela Rocketseat.
GET exemplo disponível em: https://nps-api.herokuapp.com/api-docs/
Esse projeto foi desenvolvido com as seguintes tecnologias:
Essas instruções vão te levar a uma cópia do projeto rodando em sua máquina local para propósitos de testes e desenvolvimento. Foram implementados testes de integração.
Obs: Banco de dados é o Sqlite3, caso queira alterar, configure o arquivo ormconfig.json para seu banco de dados específico (Campo "database" é o nome do banco de dados no SGBD, neste projeto é local).
- git clone https://github.com/Lucas-Angelo/nps-api.git
- cd nps-apiInstalando dependências
- npm installou
- yarn installGerar o arquivo de database.sqlite do Sqlite3, onde ficaram armazenados as tabelas da API
- yarn startTestDBCriando tabela das migrations do Sqlite3 por meio do cli do TypeOrm
- yarn typeorm migration:runInicializando uma instância local (Script configurado no package.json)
- yarn devou
Gerando a build (Script configurado no package.json)
- yarn startPara testar se instalou a aplicação corretamente e se passa em todos os testes de integração, utilize o comando:
- yarn testAs aulas foram ministradas pela Daniele Leão na Next Level Week 04.
- Faça um fork desse repositório;
- Cria uma branch com a sua feature:
git checkout -b minha-feature; - Faça commit das suas alterações:
git commit -m 'feat: Minha nova feature'; - Faça push para a sua branch:
git push origin minha-feature.
Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.