Skip to content

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.

Notifications You must be signed in to change notification settings

pratyush1712/CleverHug

Repository files navigation

-----------------------------------------------------

➤ CleverHug Email Sceduler

-----------------------------------------------------

➤ 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.

-----------------------------------------------------

➤ 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.

-----------------------------------------------------

➤ Architecture

Checkout TECHNNICAL.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.

-----------------------------------------------------

➤ Installation

  1. Clone the repository

    git clone

Frontend

  1. Navigate to the frontend directory

    cd frontend
  2. Set the environment variables

    cp .env.local
  3. Install the dependencies

     pnpm install
  4. Start the development server

    pnpm start

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

Backend

  1. Navigate to the backend directory

    cd backend
    
  2. Set the environment variables

    cp .env
  3. Install the dependencies

     pip install -r requirements.txt
  4. Start the development server

     python server.py

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

-----------------------------------------------------

➤ Screenshots

Landing Page & Login Page

Landing Page Login Page
Landing Page Login Page

Dashboard & Processed Time

Dashboard Page Processed Time
Dashboard Time Processed Time

CleverHug Scheduled

Affirmations Scheduled

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published