Cipher-MailBot

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

We have build a full stack web application where users can login and send recurring mails to the recipients.

Features:

• Login and signup via:- ○ Username - password ○ Gmail Sync (Login with Gmail option)
• The general mail features includes:- ○ To ○ CC ○ Subject ○ Schedule Selector (further explained below) ○ Mail Body ○ Send Mail Button
• The scheduling features include :- ○ Only Once - Mail will be sent Only Once. ○ Recurring schedule - Mail will automatically sent to the recipient after every 20 or 30 second ○ Weekly schedule - Mail will automatically sent to the recipient on any particular day and time of every week ○ Monthly schedule - Mail will automatically sent to the recipient on any particular date and time of every month ○ Yearly schedule - Mail will automatically be sent to the recipient on any particular date and time every year
• Home page ( have the list of all the mails scheduled for future)
• History Page ( have the list of mails sent till now )
• We have given a specific mail editor which includes :- ○ Making the text bold or italic ○ Changing the colour of the text ○ Changing the font type of the text

Built With

• Node Js
• JavaScript
• MongoDB
• Express
• Html
• CSS
• SendGrid
• Passport
• Heroku
• Bootstrap
• JQuery

Getting Started

Follow the given instructions to setup this project locally.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Online Live Link https://cipher-mailbot.herokuapp.com
2. Clone the repo

   git clone https://github.com/Arunit2001/Cipher-MailBot.git

3. Install NPM packages

   npm install

4. Create a .env file and enter your API in .env

   const mongoLink = 'ENTER YOUR Mongo Url';
   ``JS
   const JWT_SECRET = 'ENTER a secret code';
   ``JS
   const clientID = 'ENTER your google oauth client id';
   ``JS
   const clientSecret = 'ENTER your google oauth client secret';
   ``JS
   const SGKEY = 'ENTER your SENDGRID API key';
   ``JS
   
   

Contributing

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

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Phone:- 9667197161 Email:- [email protected] Phone:- 9528303487 Email:- [email protected] Phone:- 8290786228 Email:- [email protected] Phone:- 8290040908 Email:- [email protected]

Project Link: https://github.com/Arunit2001/Cipher-MailBot