{"id":24653844,"url":"https://github.com/danielaraldi/mailer","last_synced_at":"2025-03-21T00:42:46.235Z","repository":{"id":184743242,"uuid":"448345703","full_name":"DanielAraldi/mailer","owner":"DanielAraldi","description":"The best micro-saas to send e-mails from your business! 📩🏢","archived":false,"fork":false,"pushed_at":"2024-02-19T22:27:35.000Z","size":2284,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-25T21:14:14.760Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://documenter.getpostman.com/view/32462449/2s9YsT6os5","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DanielAraldi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-01-15T17:29:33.000Z","updated_at":"2024-04-29T01:18:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"b9a66db3-00f2-4f3a-9013-6805f1bfcc65","html_url":"https://github.com/DanielAraldi/mailer","commit_stats":null,"previous_names":["danielaraldi/mailer"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielAraldi%2Fmailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielAraldi%2Fmailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielAraldi%2Fmailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielAraldi%2Fmailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DanielAraldi","download_url":"https://codeload.github.com/DanielAraldi/mailer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244717347,"owners_count":20498283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-architecture","clean-code","coveralls","docker","eslint","faker","fastify","github-actions","husky","jest","lint-staged","nodejs","nodemailer","nodemon","poo","prisma","semantic-release","solid","typescript"],"created_at":"2025-01-25T21:14:18.604Z","updated_at":"2025-03-21T00:42:46.206Z","avatar_url":"https://github.com/DanielAraldi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Mailer 📫\n  \u003ch3 align=\"center\"\u003eA micro-saas to send e-mails for your business! 📩🏢\u003c/h3\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://coveralls.io/github/DanielAraldi/mailer?branch=main\"\u003e\n    \u003cimg src=\"https://coveralls.io/repos/github/DanielAraldi/mailer/badge.svg?branch=main\" alt=\"Coverage Status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://wakatime.com/badge/user/920a7e43-2969-4212-82ff-1b375685ff58/project/00e95626-aa7e-4501-a6fd-3f315bc40b35\"\u003e\n    \u003cimg src=\"https://wakatime.com/badge/user/920a7e43-2969-4212-82ff-1b375685ff58/project/00e95626-aa7e-4501-a6fd-3f315bc40b35.svg\" alt=\"Wakatime\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/DanielAraldi/Mailer?style=flat-square\"\u003e\n  \u003cimg alt=\"GitHub language count\" src=\"https://img.shields.io/github/languages/count/DanielAraldi/Mailer?style=flat-square\"\u003e\n  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/DanielAraldi/Mailer?style=flat-square\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#📖-about\"\u003eAbout\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#📫-api\"\u003eAPI\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#🛠️-how-to-execute\"\u003eHow to Execute?\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#🏷️-license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n## 📖 About\n\nThe 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).\n\n## 📫 API\n\nThere are Mailer's endpoint. All endpoint starts with slug `/api`.\n\n[`/send`](./requirements/send.md) - Endpoint to send e-mail message.\n\n## 🛠️ How to Execute?\n\n- ### **Prerequisite**\n\n  - 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.\n  - Also, it's **need** to have a package manager as **[Yarn](https://yarnpkg.com/)**, **[NPM](https://www.npmjs.com/)**, etc.\n  - Finally, it's **necessary** to have **[Node.js](https://nodejs.org/en)** greater or equal version 16.13.x.\n\n1. Make a clone of repository:\n\n```sh\n  $ git clone https://github.com/DanielAraldi/mailer.git\n```\n\n2. Added environment variables:\n\nCreate 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.\n\n3. Executing the application:\n\n```sh\n  $ npm i # or yarn install to install all dependencies.\n  $ npm run build # or yarn build to create dist folder with `.js` files that will be used in production.\n  $ npm run up # or yarn up to run database in the docker. To stop the database run the `npm run stop` command.\n  $ npm run start # or yarn start to run application.\n```\n\n## 🏷️ License\n\nThis 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielaraldi%2Fmailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielaraldi%2Fmailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielaraldi%2Fmailer/lists"}