CS3219-AY22-23 Group 54 PeerPrep

This document introduces how to get started.

• CS3219-AY22-23 Group 54 PeerPrep
  • Local Setup Instructions
    • Docker Dependencies
    • Gateway Setup
    • User Service Setup
    • Auth Service
    • Matching Service
    • Question Service
    • Collaboration Service
    • Communication Service
    • History Service
    • Frontend
    • Development
  • Deploy Instructions

Local Setup Instructions

This section introduces how to get PeerPrep running on your local environment. Skip to the development section once setting up everything once to start everything concurrently to save time starting everything individually.

Docker Dependencies

1. Install Docker from here
2. Run docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest for microservices that use websockets
3. Follow the instructions here to get an instance of judge0 running locally

Gateway Setup

1. Rename .env.sample file to .env
2. Install npm packages using npm i
3. Run the gateway using npm run dev

User Service Setup

1. Rename .env.sample file to .env
2. Create a Cloud DB URL using Mongo Atlas
3. Enter the DB URL created as DB_CLOUD_URI in .env file
4. Install npm packages using npm i
5. Run the user service using npm run dev

Auth Service

1. Rename .env.sample file to .env
2. Install npm packages using npm i
3. Run the auth service using npm run dev

Matching Service

1. Rename .env.sample file to .env
2. Create a Cloud DB URL using Mongo Atlas
3. Enter the DB URL created as DB_CLOUD_URI in .env file
4. Install npm packages using npm i
5. Run the matching service using npm run dev

Question Service

1. Rename .env.sample file to .env
2. Create a Cloud DB URL using Mongo Atlas
3. Enter the DB URL created as DB_CLOUD_URI in .env file
4. Populate the Mongo Atlas DB with questions using data.json in this folder
5. Install npm packages using npm i
6. Run the question service using npm run dev

Collaboration Service

1. Rename .env.sample file to .env
2. Install npm packages using npm i
3. Run the collaboration service using npm run dev

Communication Service

1. Rename .env.sample file to .env
2. Install npm packages using npm i
3. Run the communication service using npm run dev

History Service

1. Rename .env.sample file to .env
2. Create a Cloud DB URL using Mongo Atlas
3. Enter the DB URL created as DB_CLOUD_URI in .env file
4. Install npm packages using npm i
5. Run the history service using npm run dev

Frontend

1. Install npm packages using npm i
2. Run the frontend using npm start

Development

1. Install npm packages using npm i in the root folder
2. Run npm run start:dev in the root folder
3. Navigate to localhost:3000/ on a browser

Deploy Instructions

This section introduces how to get PeerPrep running on your AWS environment.

Prerequisites

There are 3 information needed to be retrieved from your AWS account.
They include:

1. Access Key
2. Secret Access Key
3. Default Region

These 3 information will need to be set as values to the respective envrionment variables.
They include:

1. AWS_ACCESS_KEY_ID
2. AWS_SECRET_ACCESS_KEY
3. AWS_DEFAULT_REGION

Note: For frontend, an additional REACT_APP_URI_GATEWAY environment variable needs to be set.
The value must be the domain of the gateway.

Backend Services Setup

For each backend service that contains the .ebextensions directory:

• You can deploy them by running eb deploy from their directory
• Environment variables listed in .env.sample should be specified in their respective AWS Elastic Beanstalk configurations