Merge branch 'staging' into fix-timer

Author: chiaryan

apps/README.md

@@ -16,17 +16,21 @@ In the `./apps` directory:
 ```plaintext
 .
 ├── docker-compose.yml       # Docker Compose configuration
+├── README.md                # Project documentation (for docker compose)
 ├── .env                     # Global environment variables (optional)
 ├── frontend
 │   ├── Dockerfile           # Dockerfile for frontend
 │   └── ... (other frontend files)
+├── matching-service
+│   ├── Dockerfile           # Dockerfile for matching-service
+│   └── ... (other matching-service files)
 ├── question-service
 │   ├── Dockerfile           # Dockerfile for question-service
 │   └── ... (other question-service files)
 ├── user-service
 │   ├── Dockerfile           # Dockerfile for user-service
 │   └── ... (other user-service files)
-└── README.md                # Project documentation (for docker compose)
+
 ```
 
 ## Docker Compose Setup
@@ -53,6 +57,8 @@ Once running, you can access:
 - The **frontend** at http://localhost:3000
 - The **user service** at http://localhost:3001
 - The **question service** at http://localhost:8080
+- The **matching service** at http://localhost:8081
+- The **redis service** at http://localhost:6379
 
 3. Stopping Services
 
@@ -66,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.
+
+### Known 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.
+- **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**
+### 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

@@ -38,5 +38,28 @@ services:
     volumes:
       - ./question-service:/question-service
 
+  matching-service:
+    build:
+      context: ./matching-service
+      dockerfile: Dockerfile
+    ports:
+      - 8081:8081
+    env_file:
+      - ./matching-service/.env
+    networks:
+      - apps_network
+    volumes:
+      - ./matching-service:/matching-service
+    depends_on:
+      - redis
+
+  redis:
+    image: redis:latest
+    networks:
+      - apps_network
+    ports:
+      - 6379:6379
+    container_name: redis-container
+
 networks:
   apps_network:

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/matching-service/.env.example

@@ -1,4 +1,9 @@
 PORT=8081
-MATCH_TIMEOUT=10
+MATCH_TIMEOUT=30
 JWT_SECRET=you-can-replace-this-with-your-own-secret
-REDIS_URL=localhost:6379
+
+# if you are NOT USING docker, use the below url
+REDIS_URL=localhost:6379
+
+# if you are USING docker, use the below url
+# REDIS_URL=redis-container:6379

apps/matching-service/Dockerfile

@@ -0,0 +1,18 @@
+FROM golang:1.23
+
+WORKDIR /usr/src/app
+
+# pre-copy/cache go.mod for pre-downloading dependencies and only redownloading them in subsequent builds if they change
+COPY go.mod go.sum ./
+
+RUN go mod tidy && go mod download && go mod verify
+
+COPY .env /usr/src/app/.env
+
+COPY . .
+
+RUN go build -v -o /usr/local/bin/app ./main.go
+
+EXPOSE 8081
+
+CMD ["app"]

apps/matching-service/README.md

@@ -27,7 +27,7 @@ go mod tidy
 - `PORT`: Specifies the port for the WebSocket server. Default is `8081`.
 - `JWT_SECRET`: The secret key used to verify JWT tokens.
 - `MATCH_TIMEOUT`: The time in seconds to wait for a match before timing out.
-- `REDIS_URL`: The URL for the Redis server. Default is `localhost:6379`.
+- `REDIS_URL`: The URL for the Redis server. Default is `localhost:6379`. If you are using docker, use `redis-container:6379`
 
 4. Start a local Redis server:
 
@@ -121,6 +121,28 @@ Make sure to open the HTML file in a web browser while the WebSocket server is r
 
 You can open one instance of the HTML file in multiple tabs to simulate multiple clients connecting to the server. (In the future: ensure that only one connection is allowed per user)
 
-## Docker Support
+## Running the Application via Docker
 
-TODO: Add section for Docker setup and usage instructions.
+Before running the following commands, ensure that the URL for the Redis server in `.env` file has been changed to `REDIS_URL=redis-container:6379`
+
+To run the application via Docker, run the following command:
+
+1. Set up the Go Docker container for the matching service
+```bash
+docker build -f Dockerfile -t match-go-app .
+```
+
+2. Create the Docker network for Redis and Go
+```bash
+docker network create redis-go-network
+```
+
+3. Start a new Redis container in detached mode using the Redis image from Docker Hub
+```bash
+docker run -d --name redis-container --network redis-go-network redis
+```
+
+4. Run the Go Docker container for the matching-service
+```bash
+docker run -d -p 8081:8081 --name go-app-container --network redis-go-network match-go-app
+```

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.