https://github.com/danielaraldi/mailer
The best micro-saas to send e-mails from your business! 📩🏢
https://github.com/danielaraldi/mailer
clean-architecture clean-code coveralls docker eslint faker fastify github-actions husky jest lint-staged nodejs nodemailer nodemon poo prisma semantic-release solid typescript
Last synced: over 1 year ago
JSON representation
The best micro-saas to send e-mails from your business! 📩🏢
- Host: GitHub
- URL: https://github.com/danielaraldi/mailer
- Owner: DanielAraldi
- License: mit
- Created: 2022-01-15T17:29:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T22:27:35.000Z (over 2 years ago)
- Last Synced: 2025-01-25T21:14:14.760Z (over 1 year ago)
- Topics: clean-architecture, clean-code, coveralls, docker, eslint, faker, fastify, github-actions, husky, jest, lint-staged, nodejs, nodemailer, nodemon, poo, prisma, semantic-release, solid, typescript
- Language: TypeScript
- Homepage: https://documenter.getpostman.com/view/32462449/2s9YsT6os5
- Size: 2.18 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
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](https://myaccount.google.com/apppasswords).
## 📫 API
There are Mailer's endpoint. All endpoint starts with slug `/api`.
[`/send`](./requirements/send.md) - Endpoint to send e-mail message.
## 🛠️ How to Execute?
- ### **Prerequisite**
- It's **necessary** to possess the **[Git](https://git-scm.com/)** and **[Docker](https://www.docker.com/products/docker-desktop/)** installed and configured in your computer.
- Also, it's **need** to have a package manager as **[Yarn](https://yarnpkg.com/)**, **[NPM](https://www.npmjs.com/)**, etc.
- Finally, it's **necessary** to have **[Node.js](https://nodejs.org/en)** greater or equal version 16.13.x.
1. Make a clone of repository:
```sh
$ 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:
```sh
$ 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](https://github.com/DanielAraldi) and [Rafael Mota Alves](https://github.com/RafaelMotaAlvess). We use the [MIT license](./LICENSE).