ProcrastiNot: GirlHacks 2024

The smarter way to start your assignments
Made by @rshah713, @pxpatel, @AnanyaTyagi08, and @vjanakiraman02.

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Authors

About The Project

ProcrastiNot is an AI-powered productivity tool that helps students conquer procrastination by optimizing their study schedules. It scrapes courses directly from Canvas, calculates the time needed for each assignment, and determines the most optimal start dates and times. ProcrastiNot then automatically exports this personalized schedule to Google Calendar, ensuring students stay organized, manage their workload efficiently, and never miss a deadline.

(back to top)

Getting Started

To build locally from scratch, you must build the frontend and backend seperately.

Prerequisites

The backend requires a valid OAuth 2.0 Access Token along with the dependencies listed in requirements.txt.

 git clone https://github.com/PxPatel/ProcrastiNot.git
 pip install -r requirements.txt

Installation

1. Build the backend by running uvicorn main:app --reload within /api
2. Capture the exposed local url (such as http://127.0.0.1:8000)
3. Visit chrome://extensions/
4. Press Load Extension and unpack the /frontend folder
5. Run the application and check your personal Google Calendar

(back to top)

Authors

This project was completed under NJIT GirlHacks 2024 by @rshah713, @pxpatel, @AnanyaTyagi08, and @vjanakiraman02.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)