Merge pull request #48 from CS3219-AY2425S1/frontend-websocket

docs: update readme

Author: tituschewxj

apps/README.md

@@ -72,20 +72,24 @@ This command will stop and remove the containers, networks, and volumes created
 
 ## Troubleshooting
 
-**Common Issues**
+### Common Issues
 
-- Port Conflicts: If you encounter port conflicts, ensure the host ports specified in docker-compose.yml (e.g., 3000:3000) are not in use by other applications.
-- Environment Variables Not Loaded: Ensure the `.env` files are in the correct directories as found in the `docker-compose.yml` file.
+- **Port Conflicts**: If you encounter port conflicts, ensure the host ports specified in docker-compose.yml (e.g., 3000:3000) are not in use by other applications.
+- **Environment Variables Not Loaded**: Ensure the `.env` files are in the correct directories as found in the `docker-compose.yml` file.
 
-**Logs**
+### Known Issues
+
+- **Mongo DB Connection Failing**: The user service fails to connect to the Mongo DB server on NUS Wi-Fi. To resolve this we have to use another network.
+
+### Logs
 
 You can view the logs for each service using the following command:
 
 ```bash
 docker-compose logs
 ```
 
-**Useful Commands**
+### Useful Commands
 
 Rebuild a specific service:
 

apps/docker-compose.yml

@@ -39,7 +39,7 @@ services:
       - ./question-service:/question-service
 
   matching-service:
-    build: 
+    build:
       context: ./matching-service
       dockerfile: Dockerfile
     ports:

apps/frontend/README.md

@@ -25,7 +25,7 @@ Then, follow the `.env.example` file and create a `.env` file in the current dir
 ```bash
 NEXT_PUBLIC_QUESTION_SERVICE_URL="http://localhost:8080"
 NEXT_PUBLIC_USER_SERVICE_URL="http://localhost:3001/"
-NEXT_PUBLIC_MATCHING_SERVICE_URL="wss://localhost:8081"
+NEXT_PUBLIC_MATCHING_SERVICE_URL="ws://localhost:8081"
 ```
 
 First, run the development server:

apps/user-service/README.md

@@ -303,3 +303,7 @@ docker ps
 # To stop the container, use the container ID from the previous command
 docker stop <container_id>
 ```
+
+### Known Issues with MongoDB
+
+The user service fails to connect to the Mongo DB server on NUS Wi-Fi. To resolve this we have to use another network.