Project: Study Buddy

Study Buddy is a web-based application that aims to help its users memorize, study and learn with the help of virtual flashcards. Users will be able to easily and intuitively create their own courses, decks and flashcards on an easy-to-understand website.

Prerequisites

1. Node.js v18.17.1 or newer
2. Ubuntu or Bash terminal

Step-by-Step Setup

Step 1:

Download the project file and unzip it in a directory that your terminal can access. Change the 'dot.env' file in the backend folder to just '.env'

right-click 'dot.env'
select 'rename'
type and change the name to '.env'

Step 2:

In your terminal, place yourself in the project's file directory.

Run:
cd <file_path>

Step 3:

While in the project directory change your directory to the frontend-folder

Run:
cd frontend

Then, install all the required node dependencies. These should already be in the 'package.json' file

Run:
npm install

_{Steps 3 & 4 can be done in any order you want}

Step 4:

While in the project directory change your directory to the backend-folder

Run:
cd backend

Then, install all the required node dependencies. These should already be in the 'package.json' file

Run:
npm install

_{Steps 3 & 4 can be done in any order you want}

Step 5:

Once all the dependencies have been properly downloaded. You should now be able to run the backend and the frontend respectively.

To run each component, two instances of your terminal is required. One will run the frontend and the other will be running the backend.

Terminal 1 - Backend

In this terminal, change your directory to the backend (if you're not already there).

Run:
cd backend

Then start up the backend server.

Run:
npm run dev

The terminal should show the following message when the server is up:


Each component should be able to run on their own without crashing. However, it is recommended to run the backend prior to running the frontend in order to ensure that each component works as it should.

Terminal 2 - Frontend

In this terminal, change your directory to the frontend.

Run: (from the project file directory)
cd frontend

Then start up the frontend server.

Run:
npm start

The terminal should show the following message when the server is up:


When the frontend server is up, it should open an new tab in your default browser to the Study Buddy home page.
If not, it should be at the following link:

http://localhost:3000

Database

The Database should be accessible through MongoDB Compass

Download: https://www.mongodb.com/try/download/compass

When MongoDB Compass is downloaded, paste the following link in your browser

Link: mongodb+srv://sb_admin:StudyBuddy@studybuddy.1wrnbwx.mongodb.net/?retryWrites=true&w=majority

This should request to open Compass, accept and now you should be able to view and edit the database by selecting the collection called 'test'