viniqrz / raro-mailer

🦸‍♂️ API to make easy automated employee onboarding for human resources teams. Made with TypeORM and MariaDB. [SOLID] [Domain-Driven-Design]

RaroMailer

Este projeto é o resultado do grupo High Five da Raro academy primeira edição de nodejs. Esta Api implementa um Sistema para fácil automação de envio de e-mails.

Conteúdo

• [Raro Mailer]

  • Requisitos
  • Instalação
  • Pacotes
  • Fluxo
  • Contributing

  Requisitos

  • git
  • nodejs. Sugiro que esteja na versão LTS
  • sugiro o uso do npm, para controle de pacotes. Mas se preferir, o yarn também pode ser utilizado.

  Instalação

  Os comandos abaixo descrevem a instalação básica do repositório. Se preferir, você pode adotar o clone via https, renomear a pasta raiz, ou o uso do yarn, conforme descrito acima.

  [e-mail]:viniqrz/raro-mailer.git 

  cd raro-mailer 

  neste ponto, sugere-se preencher seu novo arquivo .env com as configurações do seu projeto

  npm install 

  Pacotes

  Os pacotes utilizados neste projeto são:

• Axios

• Cors

• Express

• Morgan

• Typeorm

• Typedi

• Node-cron

• Dayjs

• Swagger UI express

• Dot Env

• Bcrypt

• Json Web Token

• Node Mailer

A tecnologia utilizada para o banco de dados foi o MariaDb

Fluxo

Este é o fluxo da API

#Roadmap

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT