Study Pod

Study pod is an all-in-one studying solution for efficient studying and working on assignments. Made for the Metro Hacks 2022 hackathon!
Explore the docs »

View Project · Report Bug · Request Feature

About The Project

Study Pod is a project made in the MetroHacks 2022 hackathon, an all-in-one study platform to boost productivity and efficiency in coursework.

Webapp features:

• Ability to register and login, creating an account which stores everything
• Create to-do lists and write notes
• Each note can be summarized into shortform with all its key information using an NLP algorithm
• Built-in music player, helping you concentrate and relax while studying

In the future, other features will also be implemented, and we will try to maintain this project for as long as possible.

(back to top)

Built With

Here is a list of services/frameworks used.

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Here are a list of instructions on setting up the project locally. In order to get a local copy up and running, follow these simple steps.

Prerequisites

What you need to install.

• python

  pacman -S python3

Installation

Below is a list of instructions on how you can install and set up the app.

1. Clone the repo

   git clone https://github.com/stampixel/StudyPod-MetroHacks2022

2. Install PIP packages

   pip install requirements.txt

3. Run the app.py file

   python3 app.py

(back to top)

Roadmap

• Improved homepage
• Better note sharing features
• Ability to play your own music
• Different sections for to-do tasks
• Set deadline and remainder for to-do tasks
• Add more note-taking features
• Profile: Share all your notes using a URL based on your username
  • Settings page
  • Profile picture
  • Setting notes to private/public

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

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

(back to top)

Acknowledgments

Thanks to the amazing group of people that have organized Metro Hacks 2022 and making it an amazing experience to participators. Special thanks to the three talented programmings for making this happen, including Nathan, Jay, and last but not least, Kevin.

GitHub Links

• @superpotato9
• @jpdotcom
• @stampixel

(back to top)

Contact

• Please contact Kevin for inquires, he is the main developer.

Be sure to leave a star, we've worked hard on this!