/peerprep

cs3219-project-ay2223s1-g60 created by GitHub Classroom

Primary LanguageTypeScript

CS3219-AY22-23-Project

This is Group 60's CS3219 project.

Group Members:

Tech Stack

Technology
Frontend ReactTS
Backend Node.js, Express.js, JWT, Redis, Selenium, Socket.io
Database MongoDB
Project Management GitHub Issues

Project Setup

Tech Stack

Node.js

Ensure you have Node.js installed in your PC. You can check by running node -v, it should return the version of Node you have.

If you don't have node installed on your machine, refer to their installation guide for details.

Our project is compatible with Node versions: 14.x, 16.x, 18.x

MongoDB Atlas

This project requires a MongoDB Atlas account. (Sign up / sign in).

Redis

Ensure you have redis installed on your host-machine, for installation details, refer to their installation guide.

Set up .env

Refer to each service's README.md to set up their .env

Running Env

To run this project, ensure that .env files are available in each *-service, and run the following commands from the project root:

# Install dependencies
npm i
npm run install-dep

# Run the project
npm run dev

Documentation