Giter Club home page Giter Club logo

peer-prep's Introduction

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.

Update (Jan 2023):

The deployed website is discontinued due to a paywall. To use this application, please setup the project in the development environment according to the instructions below.

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

peer-prep's People

Contributors

lyeyixian avatar jaredlhf avatar marcon2509 avatar thanwinnikki avatar ziyang-98 avatar github-classroom[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.