andrelinos / nlw-return-impulse-server

NLW8.0 - Return

 

NLW-08 Return - Server API

---

Sobre   |   Funcionalidades   |   Tecnologias   |   Requisistos   |   Iniciando   |   Licença   |   Autor

🎯 Sobre

Aplicação desenvolvida na NLW Return apresentada no mês de maio de 2022 com trilhas Impulse e Origin com aplicações distintas, esta é apenas o backend da aplicação impulse. A aplicação web poderá ser acessada aqui.

✨ Funcionalidades

✔️ Envio de comentários para o mailtrap
✔️ Salva em banco de dados
✔️ Testes de funcionalidades

🚀 Tecnologias

Confira abaixo as tecnologias utilizadas:

• Node.js
• TypeScript
• Prisma
• Express
• ts-node
• Nodemailer
• Jest
• Jest

✅ Requisitos

Antes de iniciar, 🏁 você precisa ter instalado o oGit e o Node.

🏁 Iniciando

# Clone o projeto
$ git clone https://github.com/andrelinos/nlw-return-impulse-server.git

# Acesse
$ cd nlw-return-impulse-server

# Instale as dependências 
$ yarn

# Execute o projeto
$ yarn start

# Assim que terminar, rode o comando abaixo para criar as migrations do banco de dados
$ yarn prisma migrate dev

# Nota: Caso não esteja usando o yarn, pode usar o npx mesmo 

# O server HTTP estará disponível em <http://localhost:3000>

Alguns detalhes importantes

• É necessário acessar o site do mailtraip.io, criar sua conta e seguir os passos abaixo para que funcione corretamente:

  • • Assim que criar, fizer o login, acesse a guia Inboxes;
  • • Clique em Add Inbox, Informe um nome qualquer e clique em Save;
  • • Agora acesse as configurações de sua Inbox, e escolha em Integrations a opção Node.js > Nodemailer
  • • Então terá algo como está no arquivo .env.example em anexo neste repositório;
  • • Basta substituir as informações do arquivo .env.examplo e depois renomeio para .env;

• Após esta configuração, sua api já irá funcionar esta parte do envio de e-mails.

📝 Licença

Este projeto está sob licença MIT. Para maiores detalhes, veja o arquivo LICENSE.

Feito com ❤️ por Andrelino Silva

 

Voltar ao top