/nlw04-api

Projeto construído durante o Next Level Week #04

Primary LanguageTypeScript

NPS-NLW04-API

API

📝 Sobre o Projeto

O NPS-NLW-API é uma API Restful para Net Promoter Score de empresa. Nele fazemos o cadastro de usuários, cadastro de pesquisas, envio de e-mail para os usuários responderem as pesquisas de satisfação e com isso podemos realizar o cálculo do NPS.

Esse projeto foi desenvolvido durante a trilha de NodeJS Back-end, na quarta edição da Next Level Week distribuída pela Rocketseat. Aprendemos conceitos sobre o que é um API, como iniciar um projeto utilizando Typescript e Express para gerenciamento das rotas, TypeORM para manipulação dos dados, testes automatizados e envio de e-mail.

🔶 Diagrama

Diagrama da aplicação

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

⤵ Comandos para começar

Foram implementados testes de integração.

- git clone https://github.com/wandsony/nlw04-api
- cd nlw04-api

Instalando dependências

- npm install

ou

- yarn install

Gerar o arquivo de database.sqlite do Sqlite3, onde ficaram armazenados as tabelas da API

- yarn devDB

Criando as migrations do Sqlite3 por meio do cli do TypeOrm

- yarn typeorm migration:run

Inicializando uma instância local (Script configurado no package.json)

- yarn dev

⤵ Testes

Para testar se a aplicação passa em todos os testes de integração, utilize o comando:

- yarn test

A aplicação pode ser acessada em:

http://localhost:3333

🔗 Links do projeto

Notion


Este projeto foi desenvolvido com ❤️ por @Wandson Gomes, com a instrutora @Daniele Leão, durante a Next Level Week na Rocketseat 💜.