Skip to content

Commit 44ea35e

Browse files
committed
docs: update readme
1 parent d3caf57 commit 44ea35e

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

apps/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,24 @@ This command will stop and remove the containers, networks, and volumes created
7272

7373
## Troubleshooting
7474

75-
**Common Issues**
75+
### Common Issues
7676

77-
- 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.
78-
- Environment Variables Not Loaded: Ensure the `.env` files are in the correct directories as found in the `docker-compose.yml` file.
77+
- **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.
78+
- **Environment Variables Not Loaded**: Ensure the `.env` files are in the correct directories as found in the `docker-compose.yml` file.
7979

80-
**Logs**
80+
### Known Issues
81+
82+
- **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.
83+
84+
### Logs
8185

8286
You can view the logs for each service using the following command:
8387

8488
```bash
8589
docker-compose logs
8690
```
8791

88-
**Useful Commands**
92+
### Useful Commands
8993

9094
Rebuild a specific service:
9195

apps/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ services:
3939
- ./question-service:/question-service
4040

4141
matching-service:
42-
build:
42+
build:
4343
context: ./matching-service
4444
dockerfile: Dockerfile
4545
ports:

apps/frontend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Then, follow the `.env.example` file and create a `.env` file in the current dir
2525
```bash
2626
NEXT_PUBLIC_QUESTION_SERVICE_URL="http://localhost:8080"
2727
NEXT_PUBLIC_USER_SERVICE_URL="http://localhost:3001/"
28-
NEXT_PUBLIC_MATCHING_SERVICE_URL="wss://localhost:8081"
28+
NEXT_PUBLIC_MATCHING_SERVICE_URL="ws://localhost:8081"
2929
```
3030

3131
First, run the development server:

apps/user-service/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,3 +303,7 @@ docker ps
303303
# To stop the container, use the container ID from the previous command
304304
docker stop <container_id>
305305
```
306+
307+
### Known Issues with MongoDB
308+
309+
The user service fails to connect to the Mongo DB server on NUS Wi-Fi. To resolve this we have to use another network.

0 commit comments

Comments
 (0)