CS3219 Project (PeerPrep) - AY2425S1

Group: G01

Production:

Deployed link: https://g01-peer-prep.vercel.app/

Admin account (if needed):

• email: [email protected]
• password: 123123

Local (How to test):

Setting up:

1. Clone our repo on your preferred IDE
2. Open 2 terminals on your IDE (One for Frontend, One for Backend)
3. Ensure you're on our latest commit on main branch
4. Create .env files in the following directories, and populate them respectively:

Note

The following section is solely for official testing in CS3219.

peer-prep-be/:

MONGODB_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
PORT=8080

message-queue/

AMQP_SERVER=amqps://lguugvwb:[email protected]/lguugvwb
MONGODB_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
PORT=3002

peer-prep-collab/src/:

PORT=4003
MATCHING_SERVICE_URL=http://localhost:3002
QUESTIONS_SERVICE_URL=http://localhost:8080
DB_CLOUD_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0

peer-prep-user/user-service/

ENV=PROD
DB_CLOUD_URI=mongodb+srv://peer-prep:[email protected]/?retryWrites=true&w=majority&appName=peer-prep-cluster0
JWT_SECRET=you-can-replace-this-with-your-own-secret

Spin up backend

Before proceeding to the following procedures, install Docker Desktop

Run the docker containers by entering the following command in the root directory:

docker compose -f docker-compose.yml up -d

Warning

Only one instance of containers should be running at any point in time. That is, let your other friends know that they need to close theirs if you're testing!

To close your containers, run the following command in the root directory:

docker compose -f docker-compose.yml down

Then, spin up the frontend

1. Install Node
2. On your frontend terminal in the root folder (cs3219-ay2425s1-project-g01), navigate to the peer-prep-fe subfolder:

cd peer-prep-fe

3. Run the command npm install to install the required packages

npm install

4. Then, run the command npm install -g @angular/cli

npm install -g @angular/cli

5. Once done, run the command ng serve to start the local development server

ng serve

6. Once the following content appears in the terminal, the local development server has been successfully started