Mailer 📫

A micro-saas to send e-mails for your business! 📩🏢

About   |    API   |    How to Execute?   |    License

📖 About

The Mailer is a service used only to send e-mail messages to people, it's focused to the business. We recommend that you use your app passwords that it's available from Google. You can create an app password clicked here.

📫 API

There are Mailer's endpoint. All endpoint starts with slug /api.

/send - Endpoint to send e-mail message.

🛠️ How to Execute?

• Prerequisite

  • It's necessary to possess the Git and Docker installed and configured in your computer.
  • Also, it's need to have a package manager as Yarn, NPM, etc.
  • Finally, it's necessary to have Node.js greater or equal version 16.13.x.

1. Make a clone of repository:

  $ git clone https://github.com/DanielAraldi/mailer.git

2. Added environment variables:

Create a new file on root path called .env. Using the .env.example file as model and added the variables that exist it for your .env file.

3. Executing the application:

  $ npm i # or yarn install to install all dependencies.
  $ npm run build # or yarn build to create dist folder with `.js` files that will be used in production.
  $ npm run up # or yarn up to run database in the docker. To stop the database run the `npm run stop` command.
  $ npm run start # or yarn start to run application.

🏷️ License

This e-mail service went development by Daniel Sansão Araldi and Rafael Mota Alves. We use the MIT license.