CS3219-AY22-23-Project-Skeleton

This is the repository for CS3219 Group 28 PeerPrep project.

Table of Contents

• Run Project Locally
• Access Project On Live

Run Project Locally

Prerequisite(s) 📝

1. Git (installation guide)

2. Docker desktop (installation guide)

3. Browser of your choice. Use Google Chrome, Mozilla Firefox or Safari for the best experience.

4. Command-line terminal

Steps 🚶

1. Navigate to the directory where you want to store this project on terminal with the command below.

   cd <path of the directory>

2. Clone this project to your local machine with the command below.

   git clone https://github.com/CS3219-AY2223S1/cs3219-project-ay2223s1-g28.git

3. Go to the project root directory with the command below.

   cd cs3219-project-ay2223s1-g28

4. Rename the file .env.sample to .env within each project folder except .github, frontend, gateway and gke. There are a total of 6 of them you need to rename.

5. Open Docker desktop.

6. Run docker compose on your terminal (within this project root directory) with the command below.

   docker-compose up --build -d

7. Wait for awhile and make sure all the Docker containers are running. Otherwise, check if you have missed out any step above.

8. Open browser of your choice.

9. Go to http://localhost:3000.

10. Start accessing the application.

11. Enjoy! 😎

Access Project On Live (Expires on 9/2/2023)

Prerequisite(s) 📝

1. Any browser of your choice. Use Google Chrome, Mozilla Firefox or Safari for the best experience.

Steps 🚶

1. Open browser of your choice.

2. Go to https://peerprepprograms.com.

3. Start accessing the application.

4. Enjoy! 😎