basic-api

Um modelo de API Rest para iniciar seus projetos!

Tabela de conteúdos

• Sobre o projeto
• Screenshots
• Como executar o projeto
• Tecnologias
• Como contribuir no projeto
• Licença

💻 Sobre o projeto

Esse projeto tem como intuito facilitar a vida de desenvolvedores criando a base de uma API REST.

📷 Screenshots

🚀 Como executar o projeto

Clone o repositório

git clone https://github.com/Typhz/AuthAPI.git

Instale as dependências

cd <REPO_NAME>
yarn install

Rode a aplicação

yarn start

✉️ Configurar MailTrap (Nodemailer)

• Abra uma conta no Mailtrap e mude as configurações do src\config\mail.json.
  

{
    "host": "",
    "port": ,
    "user": "",
    "pass":""
}

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• Express
• Nodemailer

🤝 Como contribuir no projeto

Todo tipo de contribuição é bem-vinda, nós admiramos isso!

Tem algum problema? Encontrou um bug? Tem alguma dica? Abra uma issue descrevendo.

Quer contribuir com código? Pedimos que antes leia este guia de contribuição

Não esqueça de deixar a sua ⭐, também é um modo de contribuir com o projeto ;)

📝 Licença

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

---

Criado por Patrick D. Reis 💜