Name | Email ID |
---|---|
Gnanasekaran Sanchana | sanchanag.2020 |
Koh Hui Qing | huiqing.koh.2020 |
Lim Wei Jie | weijie.lim.2020 |
Ricky Goh Rui Yu | ricky.goh.2020 |
Sophia Chow Hui Ru | sophia.chow.2020 |
What is the problem?
It’s getting harder and harder to focus. With everything going digital, the amount of time spent on our various devices has increased exponentially. The sheer amount of content exhausts our attention and leads to a decreased attention span. And studying is no exception
How do we solve it?
Introducing Focustudy, where we aim to create an environment where students can configure their studying essentials - study timer, to-dos, music. It will all be available in one application, allowing them to remain focused as they work.
- This method is applicable to both Mac OS and Windows OS
- On the '<> Code' page, click on the green 'Code' button and a dropdown will appear.
- Make sure you're under the 'HTTPS' tab, and copy the URL.
- Change the current working directory to any location where you want the cloned repository to be - use command
cd
to navigate. - Type
git clone
, and then paste the URL you copied earlier.
-
Press Enter to clone into your local machine.
-
After cloning, change directory into the local repository.
- Note that Focustudy is the root folder, containing the main sub-folders - backend and frontend.
Next, start WAMP/MAMP and import the .sql files from Focustudy/backend/sql into localhost/phpmyadmin.
- The files are located here:
-
On the localhost/phpmyadmin page, click on the 'Import' button and a 'Choose File' button will appear. Select a file and click 'Go'.
-
Make sure to import all 3 .sql files.
- Upon successful import, you should see an output similar to the one as seen in the picture below.
- Note that the screens below may defer from yours.
- Change directory into the frontend folder.
- Type
npm install
ornpm i
for short to install all the node modules used in the front-end folder.
- Note that the screens below may defer from yours.
- Go to Focusstudy/backend/docker-compose.yml.
- Ctrl + F and input 'esdg2t1'. Replace all with your docker id.
- Go to Focustudy/backend/docker-compose.yml.
- Replace the following lines with the code below:
- Line 20
dbURL: mysql+mysqlconnector://root:root@host.docker.internal:3306/timer
- Line 34
dbURL: mysql+mysqlconnector://root:root@host.docker.internal:3306/rating
- Line 129
dbURL: mysql+mysqlconnector://root:root@host.docker.internal:3306/tasklist
- Change directory into the backend folder.
- Type
docker-compose up -d
to build and run all the images in the backend folder.
- You should see the following output in the Visual Studio Code terminal:
- Note that the screens below may differ from yours.
- Change directory to the frontend folder.
- Type
npm run serve
to run the frontend. - Ctrl + Click or manually go to http://localhost:8000 to see our app!
-
Use the following account that we have prepared just for you! The account comes with database records already in place.
Email esdg2t1@gmail.com Password dockerisfun1!
- Start a study session.
- Upon completing a study session, you will be prompted to rate it.
- View, add and delete tasks in your to-do list.
- Play music from Spotify.
- Press the "History" button located at the top right of the home page.
- You will be brought to the history page where you will be able to view all your past study sessions sessions.
- Log out by clicking on the exit button at the top right corner of the home page.
- Open Postman and import Focustudy/backend/AMQP Tests.postman_collection.json.
- Requests have been prepared for you to simulate errors and activity in Record Session and Display Sessions microservices. Messages will be printed in the console.