felipe-b-oliveira/ocean-nps

Aplicação de estudo desenvolvida em NodeJS e Typescript referente a NLW04 da Rocketseat

Sistema de avaliação

Projeto de estudo referente a NLW#4 da Rocketseat

Ver Demo · Reportar Bug · Requisitar Feature

Tabela de Conteúdo

• Sobre o Projeto
  • Tecnologias
• Iniciando
  • Pre Requisitos
  • Instalação
• Endpoints
• Contribuindo
• Licença
• Contato

Sobre o Projeto

Projeto de estudo referente a um sistema backend de atribuição e avaliação de notas com cálculo de nps.

Tecnologias

Lista de principais ferramentas utilizadas no projeto.

• NodeJS
• Typescript
• Jest
• Handlebars

Iniciando

Instruções de como configurar e executar o projeto localmente.

Pre Requisitos

O projeto utiliza o Yarn, você pode conferir como instalá-lo em seu sistema aqui: Yarn Installation

Instalação

1. Clone o repositório usando o comando abaixo:

git clone https://github.com/felipe-b-oliveira/ocean-nps

2. Acesse a pasta do projeto e dentro da mesma execute o comando:

yarn install

3. Execute o comando abaixo para executar o projeto

yarn dev

Endpoints

Users

• Create: POST /users

Surveys

• Create: POST /surveys

• GetAll: GET /surveys

SendMail

• Execute: POST /sendMail

Answers

• GetAll: GET /answers/:value

NPS

• FindById: GET /nps/:survey_id

Contribuindo

Contribuições são muito bem vindas 😎.

1. Faça Fork desse repositório;
2. Crie uma branch com a sua feature: git checkout -b feature/MinhaFeature
3. Commit suas mudanças: git commit -m 'feat: Minha nova feature'
4. Push a sua branch: git push origin feature/MinhaFeature
5. Abra uma Pull Request

Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Contato

---

Feito por Felipe Oliveira

[home]: