Update readme

Author: ruiqi7

README.md

@@ -28,4 +28,5 @@ docker-compose down
 
 - User Service: http://localhost:3001
 - Question Service: http://localhost:3000
+- Matching Service: http://localhost:3002
 - Frontend: http://localhost:5173

backend/README.md

@@ -6,6 +6,8 @@
 
 2. Set-up Firebase.
 
+3. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+
 ## Setting-up local MongoDB (only if you are using Docker)
 
 1. In the `backend` directory, create a copy of the `.env.sample` file and name it `.env`.

backend/matching-service/README.md

@@ -1,25 +1,24 @@
-# Matching Service
+# Matching Service Guide
+
+> Please ensure that you have completed the backend set-up [here](../README.md) before proceeding.
 
 ## Setting-up Matching Service
 
 1. In the `matching-service` directory, create a copy of the `.env.sample` file and name it `.env`. If you are looking to run matching service with the other services using docker-compose, comment out the variable `RABBITMQ_ADDR` under use case (1) in the .env file. Otherwise, if you are looking to run matching service individually, comment out the variables `RABBITMQ_DEFAULT_USER`, `RABBITMQ_DEFAULT_PASS` and `RABBITMQ_ADDR` under use case (2) in the .env file.
 
-2. If you are running matching service together with other services using docker-compose, to set up credentials for RabbitMq, update the RabbitMq variables in the `.env` file. Update `RABBITMQ_DEFAULT_USER` and `RABBITMQ_DEFAULT_PASS` to what you want, then update `RABBITMQ_ADDR` to be `amqp://<RABBITMQ_DEFAULT_USER>:<RABBITMQ_DEFAULT_PASS>@rabbitmq:5672`.
-You can access RabbitMq management user interface locally with the username in `RABBITMQ_DEFAULT_USER` and password in `RABBITMQ_DEFAULT_PASS` at http://localhost:15672.
+2. If you are running matching service together with other services using docker-compose, to set up credentials for RabbitMq, update the RabbitMq variables in the `.env` file. Update `RABBITMQ_DEFAULT_USER` and `RABBITMQ_DEFAULT_PASS` to what you want, then update `RABBITMQ_ADDR` to be `amqp://<RABBITMQ_DEFAULT_USER>:<RABBITMQ_DEFAULT_PASS>@rabbitmq:5672`. You can access RabbitMq management user interface locally with the username in `RABBITMQ_DEFAULT_USER` and password in `RABBITMQ_DEFAULT_PASS` at http://localhost:15672.
 
 3. If you are running matching service individually, you do not need to make any changes to `RABBITMQ_ADDR`. You can access RabbitMq management user interface locally with the username `guest` and password `guest` at http://localhost:15672.
 
 ## Running Matching Service Individually with Docker
 
-1. Set up and run RabbitMq locally on your computer with the command `docker run -it --rm --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:4.0-management`.
-
-2. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+1. Set up and run RabbitMq locally on your computer with the command `docker run -it --rm --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:4.0-management`. If you encounter connection errors, please wait for a few minutes as RabbitMq may take some time to start up.
 
-3. Open Command Line/Terminal and navigate into the `matching-service` directory.
+2. Open Command Line/Terminal and navigate into the `matching-service` directory.
 
-4. Run the command: `npm install`. This will install all the necessary dependencies.
+3. Run the command: `npm install`. This will install all the necessary dependencies.
 
-5. Run the command `npm start` to start the Matching Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+4. Run the command `npm start` to start the Matching Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
 ## After running
 

backend/question-service/README.md

@@ -1,6 +1,6 @@
-# Question Service
+# Question Service Guide
 
-> If you have not set-up either a local or cloud MongoDB, as well as Firebase, visit [this](../README.md) before proceeding.
+> Please ensure that you have completed the backend set-up [here](../README.md) before proceeding.
 
 ## Setting-up Question Service
 
@@ -12,13 +12,11 @@
 
 ## Running Question Service without Docker
 
-1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+1. Open Command Line/Terminal and navigate into the `question-service` directory.
 
-2. Open Command Line/Terminal and navigate into the `question-service` directory.
+2. Run the command: `npm install`. This will install all the necessary dependencies.
 
-3. Run the command: `npm install`. This will install all the necessary dependencies.
-
-4. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+3. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
 ## Seeding questions into MongoDB
 

backend/user-service/README.md

@@ -1,6 +1,6 @@
 # User Service Guide
 
-> If you have not set-up either a local or cloud MongoDB, as well as Firebase, visit [this](../README.md) before proceeding.
+> Please ensure that you have completed the backend set-up [here](../README.md) before proceeding.
 
 ## Setting-up User Service
 
@@ -14,13 +14,11 @@
 
 ## Running User Service without Docker
 
-1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+1. Open Command Line/Terminal and navigate into the `user-service` directory.
 
-2. Open Command Line/Terminal and navigate into the `user-service` directory.
+2. Run the command: `npm install`. This will install all the necessary dependencies.
 
-3. Run the command: `npm install`. This will install all the necessary dependencies.
-
-4. Run the command `npm start` to start the User Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+3. Run the command `npm start` to start the User Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
 ## After running
 

frontend/README.md

@@ -1,4 +1,4 @@
-# PeerPrep Frontend
+# Frontend Guide
 
 ## Running Frontend
 
@@ -8,4 +8,4 @@
 
 3. Run `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
 
-4. The application is available at http://localhost:5173.
+4. The application is available at http://localhost:5173. If you would like to run the application on a different URL, please update the `ORIGINS` variable in the various `.env` files located in the backend directory.