bhansaliyash / MailerOwl

All in one Email Marketing Solution using Python and Django

MailerOwl - All in one Email Marketing Solution

Link to Deployed Application

Report Bug · Request Feature

MailerOwl provides user functionality to schedule, send instant or recurring emails. User can also check the status of the emails from admin panel. Through our application, a user can schedule recurring emails to be sent over a particular duration that can be decided by the user. This product can be used by marketing teams to advertise their products and promotions to daily customers over a regular period of time.

🏆 Features

• Sending Email
• Email Scheduling
• Send Recurring Email
• Check Email Logs

🚀 Video + Demo

📖 Documentation

The detailed documentation for the code can be found at - MailerOwl Docs

🛠 Installation Guide

1. Install Docker on your operating system.
2. Clone the github repository at a preferable location in your system.

git clone https://github.com/divyang02/MailerOwl.git
cd MailerOwl

3. Create your account on MailJet and generate an API Key and API Secret Token.
4. Copy the content of mail_sender.settings.py and make a new file local_settings.py in the same folder.
5. Update MAILJET_API_KEY and MAILJET_API_SECRET fields in the local_settings.py.
6. In local_settings.py update NAME, PASSWORD and USER fields as per your database config as written in docker-compose file in DATABASES dictionary
7. Go to apps/email_scheduler/constants.py and update DEFAULT_FROM_EMAIL.
8. Run docker compose up in a new terminal.
9. Open another terminal and run the command docker exec -it mail_sender sh .
10. In this terminal run the command python manage.py createsuperuser --settings=mail_sender.local_settings.
11. Open your browser and go to 0.0.0.0:8000/admin.
12. Login with your login credentials and enjoy the application.

👤 Who can use our app

1. If you are a user who is visiting our app, you can sign up as a user with view access to emails and email campaigns. You cannot edit or create your own email for security purposes.
2. If you are an admin user, you can create, view, update and delete email and schedule email.
3. To request for admin privileges, please email on [e-mail] with the purpose of use.

❗ TroubleShooting and Help Guide

1. For any issues faced while using the application, please email the detailed description and steps to reproduce the error at [e-mail] .
2. If you are a developer, please raise an issue on github with steps to reproduce and possible source of error.
3. Our email is monitored 24x7 and we usually respond within 1 hour. Happy Emailing :).

🎯 Plan of Action

Phase 1

1. Implement user registration and login functionality.
2. UI for user login and registration.
3. Implement simple email sending feature using Mailjet API.
4. Add feature to allow users to schedule emails.
5. Add recurring email functionality.
6. Include application logging to monitor status of the emails.
7. Dockerize the application
8. Deploying applicatin on server

🍰 Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

👥 Contributors

Group 46

Divyang Doshi

Priyam Garg

Yash Bhansali

Dev Mehta

Manogna Choudary Potluri