Node.js

Sobre   |    Funcionalidades   |    Tecnologias   |    Como Executar   |    Variáveis de Ambiente   |    Rodando os Testes   |    Diagrama   |    Licença

🔖 Sobre

O npsMail é uma aplicação que consiste em calcular o NPS da empresa, desenvolvido durante a trilha de NodeJS, na quarta edição da NLW. 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.

⚙️ Funcionalidades

• Cadastro de usuários
• Cadastro de pesquisas
• Envio de e-mail
• Recebimento da resposta

🚀 Tecnologias

• TypeScript
• Ethereal-Email
• TypeORM
• Express
• Jest
• SQL Editor Beekeeper Studio

💥 Como Executar

• Pré-requisitos

  • É necessário possuir o Node.js instalado no computador
  • É necessário possuir o Git instalado e configurado no computador
  • Também, é necessário ter um gerenciador de pacotes seja o Yarn ou NPM.

1. Clone o repositório:

  $ git clone https://github.com/PauloEwerson/npsMail.git

2. Entre no diretório do projeto:

  cd npsMail

3. Execute a aplicação:

  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  
  # Configurando o banco de dados e criando as tabelas.
  $ yarn migrate # ou npm run migrate

  # Inicie a API (modo de desenvolvimento)
  $ yarn dev # ou npm run dev

🔒 Variáveis de Ambiente

Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu .env

NODE_ENV=development API_PORT=3333 URL_MAIL=http://localhost:3333/answers

🧑‍🔬 Rodando os Testes

Para rodar os testes, execute o seguinte comando

  $ yarn test # ou npm run test

📋 Diagrama

📝 Licença

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

---

^{Projeto desenvolvido com a tutoria da Rocketseat.}