https://github.com/pratyush1712/cleverhug

CleverHug is an email scheduler application that allows users to schedule emails to be sent at a later time or at recurring intervals. The system is designed with a user-friendly interface, ensuring easy navigation and operation.
https://github.com/pratyush1712/cleverhug

email-scheduling flask ical react-typescript rrule-string

Last synced: 9 days ago
JSON representation

CleverHug is an email scheduler application that allows users to schedule emails to be sent at a later time or at recurring intervals. The system is designed with a user-friendly interface, ensuring easy navigation and operation.

• Host: GitHub
• URL: https://github.com/pratyush1712/cleverhug
• Owner: pratyush1712
• Created: 2024-05-08T02:47:18.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-05-15T00:15:19.000Z (8 months ago)
• Last Synced: 2024-11-07T04:14:17.614Z (about 2 months ago)
• Topics: email-scheduling, flask, ical, react-typescript, rrule-string
• Language: Python
• Homepage: https://cleverhugs.life
• Size: 2.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#cleverhug-email-sceduler)

# ➤ CleverHug Email Sceduler

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#description)

## ➤ Description

CleverHug is an email scheduler that allows users to schedule emails to be sent to themselves at a later time. The emails can be scheduled to be sent at a specific time or at a recurring time. The user can also view the emails that have been scheduled and the time at which they were processed.

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#features)

## ➤ Features

1. **Schedule Emails**: Users can schedule emails to be sent to themselves at a later time.

2. **Recurring Emails**: Users can schedule emails to be sent to themselves at a recurring time.

3. **View Scheduled Emails**: Users can view the emails that have been scheduled.

4. **View Processed Time**: Users can view the time at which the emails were processed.

5. **Responsive and Easy to use Interface**: Users can easily set schedules with just one line of input.

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#architecture)

## ➤ Architecture

Checkout [`TECHNNICAL.md`](./TECHNICAL.md) for an indepth understanding of the architecutre and the modules used.

### Frontend

The frontend is built using `React.js` `Typescript` and `pnpm` and is hosted on Vercel.

### Backend

The backend is built using `Flask` and is hosted on `Vercel` as well.

The backend uses a variation of the `recurrent` library to parse the `rrule` format from the user's input and schedule the emails accordingly.

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#installation)

## ➤ Installation

1. Clone the repository

   ```bash

   git clone

   ```

### Frontend

1. Navigate to the `frontend` directory

   ```bash

   cd frontend

   ```

2. Set the environment variables

   ```bash

   cp .env.local

   ```

3. Install the dependencies

   ```bash

    pnpm install

   ```

4. Start the development server

   ```bash

   pnpm start

   ```

The frontend should now be running on `http://localhost:3000`

### Backend

1. Navigate to the `backend` directory

   ```bash

   cd backend

   ```

2. Set the environment variables

   ```bash

   cp .env

   ```

3. Install the dependencies

   ```bash

    pip install -r requirements.txt

   ```

4. Start the development server

   ```bash

    python server.py

   ```

The backend should now be running on `http://localhost:3001`

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)](#screenshots)

## ➤ Screenshots

### Landing Page & Login Page

| ![Landing Page](./screenshots/landing.png) | ![Login Page](./screenshots/login.png) |

| :----------------------------------------: | :------------------------------------: |

|              **Landing Page**              |             **Login Page**             |

### Dashboard & Processed Time

| ![Dashboard Page](./screenshots/dashboard.png) | ![Processed Time](./screenshots/processed_time.png) |

| :--------------------------------------------: | :-------------------------------------------------: |

|               **Dashboard Time**               |                 **Processed Time**                  |

### CleverHug Scheduled

![Affirmations Scheduled](./screenshots/scheduled.png)