Skip to content

Latest commit

 

History

History
159 lines (120 loc) · 5.65 KB

README.md

File metadata and controls

159 lines (120 loc) · 5.65 KB
Raw

mystudy-space logo

A cozy space for quiet studies and collecting plushies.

Built for Stormhack 2022.
Explore the docs »

View Demo · Report Bug · Request Feature

✨ Inspiration

Being students, our team wanted to address the issues of self-study and motivation, especially during these pandemic times where school has shifted primarily online. Inspired by applications such as Daylio and Forest, we hope to provide an all-in-one platform that aims to address these issues using methods such as the Pomodoro technique, mood journaling, and gamification.

💻 What it does

Study in Peace

Employing the Pomodoro technique, set your preferred study intervals, the number of intervals, and the break time in-between. The application will automatically do the rest and log your study time on a timeline to further increase accountability. Furthermore, to assist with managing distractions, the rain mode will dim the screen and play a relaxing rain ambiance to help you stay focused.

Track your Mood

Following every time interval, a mood tracking questionnaire will check up on you on your current mood using a simple scale that is automatically recorded to the timeline. Based on your response, an idea of how to spend your break will appear that will get you primed and ready for the next interval.

Collect Plushies

During your studies, you may notice that your room gradually fills with adorable plushies. To further incentivize studying, we added the ability to collect plushies as you complete study sessions to fill your virtual room.

Share With Friends

Share your accomplishments with your friends by sending them a custom URL linking to your virtual room and show off your collection of plushies. While they're there, they may be able to leave a special plushie as a gift to signify your friendship.

⚡️ Quick start

First of all, download and install Node.js. Version 14.7.0 LTS or higher is recommended.

Then, download and install Python 3. Version 3.6 or higher is recommended.

Clone directory:

$ git clone [email protected]:quarterblue/mystudy-space.git

Frontend:

# Change directory:
$ cd mystudy-space/frontend/

# Installation:
$ npm install

# Start client server:
$ npm run dev

Backend:

# Change directory:
$ cd mystudy-space/backend/

# Installation:
$ pip3 install -r requirements.txt

# Start backend server:
$ python3 main.py

Then navigate to http://localhost:3000/ on your browser.

🐳 Docker-way to quick start

Make sure you have installed docker and docker-compose on your computer

Clone directory:

$ git clone [email protected]:quarterblue/mystudy-space.git

Run:

# Change directory:
$ cd mystudy-space/

# Run:
$ docker-compose build

# Then Run:
$ docker-compose up -d

Then navigate to http://localhost:3000/ on your browser.

You might need to wait a couple minutes for everything in docker to be loaded.

Features

  • Login & Authentication
  • Plushie Inventory (Personal Room)
  • Timeline for tracking activities
  • Dynamic timer and interval setter
  • Send plushie to friends!
  • Browse friends personal room
  • Self-help & mood tracker
  • Calm and soothing rain music

Directory Structure

  • backend (Where the backend code is stored, python flask is used as the backend server)
    • interface (Contains all the interface files)
    • manager (Contains all the manager files)
    • model (Contains our data class for commits, mergre requests etc.)
    • test (Contains all the test and unittest files)
    • main.py (Main server file)
  • frontend (Where the front-end client code is stored, reactjs is used)
    • public
    • src
      • components
      • context
      • pages
      • public
      • various files
  • various docker files for building and deploying

Credits

This software uses the following open source packages:

License

AGPL v3.0