Skip to content

CS3219-AY2223S1/cs3219-project-ay2223s1-g52

Repository files navigation

CS3219 AY22/23 Project - PeerPrep (by Team G52)

PeerPrep is a web application that helps students better prepare themselves for technical interviews. It provides a collaborative interview preparation platform and peer matching system, where students can find peers to practice whiteboard-style interview questions together.

Visit the deployed website here.

Installing / Getting started

Requirements

  • Install Node.js and NPM. We prefer using a Node Version Manager, you can follow the instructions here to install for Mac or Windows. The version of Node that we are using is 16.
  • Install Docker, for Mac or Windows
  • Install MongoDB
  • Install Redis

Development

1. Using Docker Compose

  1. Clone the repo
  2. Navigate to Dockerfile in the frontend directory
  3. Uncomment "REACT_APP_ENV=DEV"
  4. Run the following command
docker compose -f docker-compose-all.yaml up --build

The above command will build and run the docker containers. You can then access the website at http://localhost

2. Running each services locally

  1. Clone the repo
  2. cd into each directories and follow the instructions on the README of each services: Frontend, User Service, Matching Service, Collaboration Service, Question Service, Communication Service, History Service
  3. Then, you can access the website at http://localhost:3000
For example:

    cd frontend
    npm install
    npm start

About

cs3219-project-ay2223s1-g52 created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published