README

Online Access

Access our app via the url:
https://peerprep-g16.netlify.app/

Local (dev) Access

Backend

1. Set up database

Create a local MySQL database named peerprep. Make sure the database is running on localhost port 3306. Note: this operation may require root previlege.
- In terminal, run sudo mysql to connect to mysql as root user.
- In mysql console, run create database peerprep;
In mysql console, create a database user using the following mysql command:

create user peerprep_admin identified by 'cs3219_G16_yyds';
In mysql console, grant previleges to peerprep_admin using the following mysql command:

grant all privileges on peerprep.* to peerprep_admin;
In mysql console, connect to database peerprep:

use peerprep;
In our repo directory ./peerprep/src/main/resources/sql/, look for two files create_user_profile_table.sql and create_peerprep_interview_tables.sql. Copy the SQL scripts from these two files and execute in mysql console.
So far, the tables have been set up.

2. Import interview question & solutions into database tables

In our repo directory ./peerprep/src/main/resources/data/, look for two csv files Copy of leetcode questions.csv and Copy of leetcode solutions.csv which contain the questions and solutions used for our application
Simply use the MySQL visualization tool (MySQL Workbench, phpMyAdmin, etc.) to import Copy of leetcode questions.csv and Copy of leetcode solutions.csv into table interview_questions and table interview_solutions respectively.

3. Install local mail server

A local mail server is needed if you want to register a new account or reset password in our app.

Here we use MailDev. Open your terminal, do the following to set up MailDev:

Install MailDev:

npm install -g maildev
Run MailDev:

maildev
Access MailDev email portal via the link displayed on terminal. Usually it would be http://0.0.0.0:1080.
For registering new account in our app, you need to go to this email portal to activate your account.
For resetting password in our app, you need to go to this email portal to get the link for reset.

For more information about MailDev, you may refer to this repository: https://github.com/maildev/maildev

4. Download backend `jar` file

Download the jar file to an empty folder from the latest Release in our GitHub repository.
cd to the folder where the jar file is downloaded.

5. Run backend locally

Run the jar file with command:

java -jar -Dspring.profiles.active=dev <jar-file-name>

Frontend

Deployed domian: https://peerprep-g16.netlify.app/

Steps to setup the frontend:

Using NPM:

In the frontend folder, run:

npm install
npm start

Using Yarn:

In the frontend folder, run:

yarn install
yarn start

Steps to toggle between local and production environments:

For Restful APIs

Open src/apiHandler folder
Toggle the comment at line 4 and 5 of each file in the folder to choose the URL to the corresponding backend server

To use the remote backend sever, please edit line 3-6 of each file in the folder as below:

const client = axios.create({
  // baseURL: "http://localhost:8080/api/v1",
  baseURL: "https://peerprep-backend-service-mepxozmoha-as.a.run.app/api/v1"
});

To use the local backend sever, please edit line 3-6 of each file in the folder as below:

const client = axios.create({
  baseURL: "http://localhost:8080/api/v1",
  // baseURL: "https://peerprep-backend-service-mepxozmoha-as.a.run.app/api/v1"
});

For WebSocket API

Open src/view/pages/authenticated/InterviewDashboard
Toggle the comment at line 36 and 37 choose the URL to the corresponding backend server

To use the remote backend sever:

  const [editingUrl, setEditingUrl] = useState("wss://peerprep-backend-service-mepxozmoha-as.a.run.app/interview/")
  // const [editingUrl, setEditingUrl] = useState("ws://localhost:8080/interview/")

To use the local backend sever:

  // const [editingUrl, setEditingUrl] = useState("wss://peerprep-backend-service-mepxozmoha-as.a.run.app/interview/")
  const [editingUrl, setEditingUrl] = useState("ws://localhost:8080/interview/")

shuiyao-sg/cs3219-project-ay2122-2122-s1-g16