Maildart

A mass mailer operating through a given set of emails in CSV/JSON
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Roadmap
3. Usage
4. Contributing
5. License

---

About The Project

Ever wanted to send mass e-mails to particular users, say no more. Maildart, the one-shot tech that will solve your problems.

This is a platform which is used to send mass emails using multiple platforms like listmonk, mailgun, nodemailer and sendgrid. It can also show you the live preview of the email and in the end it will show you which emails were sent and which failed in a minimalistic console.

Built With

• Nodejs
• Express

---

Roadmap

See the notion guide for a list of proposed features.

---

Usage

To setup project locally, fork the repository.

# install dependencies
npm install

# run the server
nodemon app.js

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

• Fork the repository by clicking the fork button on top right corner of the page
• Clone the target repository. To clone, click on the clone button and copy the https address. Then run

git clone https://github.com/ACM-VIT/maildart-backend.git

• Go to the cloned directory by running

cd maildart-backend

• Create a new branch. Use

git checkout -b [YOUR-BRANCH-NAME]

• Make your changes to the code. Add changes to your branch by using

git add .

• Commit the chanes by executing

git commit -m "your msg"

• Push to remote. To do this, run

git push origin [YOUR-BRANCH-NAME]

• Create a pull request. Go to the target repository and click on the "Compare & pull request" button. Make sure your PR description mentions which issues you're solving.
• Wait for your request to be accepted.

---

License

Distributed under the MIT License. See LICENSE for more information.