cs3219-project-ay2122-2122-s1-g8

cs3219-project-ay2122-2122-s1-g8 created by GitHub Classroom

PeerPrep

Note: The current repository has connected frontend to fetch data from the backend.

To run the application, please ensure npm is installed on your local machine.

1. Set up Environment

1. Install Redis
2. Install MongoDB
3. Install Node Package Manager (npm)

2. To start the backend locally

In the project root directory, you can run:

• cd backend into the 'backend' folder
• npm install to installs needed dependancies.
• redis-server to starts up the redis server.
• node index.js to run the Express server.
  Open http://localhost:3030 to view it in the browser.

Note: redis-server command can only be run in Linux. If you are using Windows, please use Windows subsystem Linux.

3. To start the frontend locally

In the project root directory, you can run:

• cd frontend into the 'frontend' folder
• npm install to install needed dependancies. Note that backend and frontend folders have different dependencies, so this second npm install is needed
• npm start runs the app in the development mode.
  Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Note: Running the frontend locally will send requests to the deployed backend.

4. To access the deployed application

Backend is available on https://peerprep.herokuapp.com/, while frontend is available on https://peerprep-client.herokuapp.com/