Skip to content

Repository files navigation

Study Assistant 📚

This is a simple web based assistant for studying! You can start a focus session, that will last 25 minutes before telling you to take a break, see your homework and for when its scheduled, and see your grades and calculate averages.

The website is not fully functional yet, since I have only recently started development. Grades and homework aren't functional yet, but the focus timer works.

I will be adding grades and homework functionallity in the next update.

Demo Link

https://study-assistant-steel-gamma.vercel.app/

Color Reference

Color Hex
Background Color #f3e8d8 #f3e8d8
Button Hover Color #ffa936 #ffa936

Deployment

To deploy this project:

First download the LTS Version from https://nodejs.org/en

Check if the installation is succesfull by running node -v


Then download and install git from https://git-scm.com/install

Check if the installation is succesfull by running git --Version


Clone the github repository with

git clone https://github.com/guccmanegu-eng/study-assistant.git

Then run the following command so you are inside the correct folder.

cd study-assistant

install all requirements with

npm install

Starting the local server

Start the local server, so the assistant is ready to use with:

  npm run dev

This readme.md is made with a website i found online, https://readme.so

Releases

Packages

Contributors

Languages