Feedback

.env.sample

@@ -0,0 +1,34 @@
+# Docker Hub username to push images to
+DOCKER_USERNAME=wuemily 
+
+# Database URIs
+QUESTION_DB_CLOUD_URI={question-db-cloud-uri}
+QUESTION_DB_LOCAL_URI={question-db-local-uri}
+
+USER_DB_CLOUD_URI={user-db-cloud-uri}
+USER_DB_LOCAL_URI={user-db-local-uri}
+
+COLLAB_DB_CLOUD_URI={collab-db-cloud-uri}
+COLLAB_DB_LOCAL_URI={collab-db-local-uri}
+
+HISTORY_DB_CLOUD_URI={history-db-cloud-uri}
+HISTORY_DB_LOCAL_URI={history-db-local-uri}
+
+# Services ports (set to default ports)
+QUESTION_PORT=3001 
+USER_PORT=3002 
+MATCHING_PORT=8080 
+COLLAB_PORT=8081 
+GATEWAY_PORT=4000 
+HISTORY_PORT=8082 
+
+JWT_SECRET={jwt-secret} 
+
+ENV=PROD 
+
+# Email account for sending password reset emails 
+EMAIL_USER={email-user}
+EMAIL_PASSWORD={email-pass}
+
+# Set to default port
+FRONTEND_URL=http://localhost:3000

.gitignore

@@ -0,0 +1,29 @@
+# Global ignores
+.vscode/
+.idea/
+.DS_Store
+*.log
+*node_modules/
+
+# Exclude environment files
+*.env
+
+# Exclude secret deployment file
+*secret.yaml
+
+
+# Node.js dependencies
+node_modules/
+
+# Build directories
+build/
+dist/
+
+# Temporary files
+tmp/
+temp/
+*.tmp
+*.swp
+
+# Output of npm pack
+*.tgz

HPA-SETUP.md

@@ -0,0 +1,46 @@
+N8: Scalability
+## Kubernetes and Horizontal Pod Auto-scaler (HPA)
+The application uses Horizontal Pod Autoscalers (HPAs) to manage scalability based on CPU utilization. The HPAs automatically adjust the number of pods for each service based on the load.
+
+### Configuration Infomation
+Each microservice has its own HPA configuration file located in the `./k8` directory. 
+- The HPA settings by default are:
+    - Min Replicas: The minimum number of pod replicas (e.g., 1).
+    - Max Replicas: The maximum number of pod replicas (e.g., 10).
+    - Target CPU Utilization: The desired average CPU utilization (e.g., 50%).
+- The HPA configuration files for each service are:
+    - Frontend: `k8/hpas/frontend-hpa.yaml`
+	- Collaboration Service: `k8/hpas/collaboration-service-hpa.yaml`
+	- Matching Service: `k8/hpas/matching-service-hpa.yaml`
+	- Question Service: `k8/hpas/question-service-hpa.yaml`
+	- User Service: `k8/hpas/user-service-hpa.yaml`
+    - History Service: `k8/hpas/history-service-hpa.yaml`
+
+### Setup Instructions
+- **Step 1: Setting up Docker Images.**
+Ensure repository is cloned, and `.env` file is added. **Note:** `./k8/app-config.yaml` should hold the same ports and urls variables as the .env file. If there are discrepencies, update them to match. If you would like to change the ports for the services, you need to update ports in the app-config, and the relevant deployment and service `.yaml` files. 
+    - If you want to use your own Docker Hub repository (where you will need to then push to), specify your Docker Hub ID in the .env **and** change image names in `.yaml`s in `./k8/deployments` for the microservices (so excluding redis and metrics-server deployments) to replace `wuemily` with your docker hub ID. 
+	    - After building the Docker images (steps 3 and 4 in `README.md`), push them with:
+`docker push dockerhubid/question-service:latest`
+`docker push dockerhubid/user-service:latest`
+`docker push dockerhubid/matching-service:latest`
+`docker push dockerhubid/collaboration-service:latest`
+`docker push dockerhubid/frontend:latest`
+`docker push dockerhubid/api-gateway:latest`
+`docker push dockerhubid/history-service:latest`
+    - Alternatively, you can also use existing public reposity by setting the Docker Hub ID to wuemily; no need to push images or make changes in `.yaml` files. 
+- **Step 2: Setting up Minikube and Kubernetes.**
+This assumes some basic understanding of Minikube and Kubernetes and they are both installed.
+    - Start Minikube with: ``minikube start --driver=docker``
+    - To apply the HPA configurations to your Kubernetes cluster, use the following commands (from root folder):
+        `kubectl apply -f ./k8`
+        `kubectl apply -f ./k8/deployments`
+        `kubectl apply -f ./k8/services`
+        `kubectl apply -f ./k8/statefulsets`
+        `kubectl apply -f ./k8/hpas`
+    - If load balancers appear to be not working, it may be because of the local hosting. Make sure `minikube tunnel` is running.
+- **Step 3: Monitoring**
+You can monitor the scaling behavior using `kubectl` commands. 
+- `kubectl get hpa`displays the current status of all HPAs in the cluster, including the current and desired number of replicas based on CPU usage.
+    - If CPU usage is `unknown`, check if Minikube metrics server addon is enabled with `minikube adddons list`, if it isn't, enable with `minikube addons enable metrics-server`. 
+- Can also observe pods and their status with `kubectl get pods` and `minikube dashboard`, depending on your preference. 

README.md

@@ -1,7 +1,29 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/bzPrOe11)
 # CS3219 Project (PeerPrep) - AY2425S1
-## Group: Gxx
+## Group: G23
 
 ### Note: 
 - You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice. 
 - In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator. 
 - The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements. 
+
+### Run
+- **Step 1:** Clone the repository.
+- **Step 2:** Setup the necessary .env files in the /frontend and root folder using the .env.sample templates in both folders. 
+    - Fill in the necessary information enclosed by curly brackets {}. 
+    - The default ports are given by defefault as:
+        - GATEWAY_PORT=4000 
+        - QUESTION_PORT=3001 
+        - USER_PORT=3002 
+        - MATCHING_PORT=8080 
+        - COLLAB_PORT=8081 
+        - HISTORY_PORT=8082 
+        - If setting custom ports:
+            - Avoid using port 3000, as the React app runs on that port.
+            - For instructions on using Kubernetes, refer to the `HPA-SETUP.md` file. You may have to edit additional files for custom ports to work.
+- **Step 3:** Run `docker --version` to check if docker is correctly installed. If not, ensure it is. 
+- **Step 4:** Run `docker-compose up --build -d ` command in terminal to build and run the app. 
+- **Step 5:** Go to http://localhost:3000 to see the application and services running. 
+- **Step 6:** Run `docker compose down` to stop running Docker containers. 
+    - You can also run `docker compose down`, then `docker compose up -d` again to restart backend services. 
+- If using Kubernetes, please refer to `HPA-SETUP.md`. 

docker-compose.yml

@@ -0,0 +1,190 @@
+version: '3.9'
+
+services:
+  question-service:
+    container_name: question-service
+    restart: on-failure
+    build: 
+      context: ./services/question-service
+      args:
+        - PORT=${QUESTION_PORT}
+    image: ${DOCKER_USERNAME}/question-service:latest
+    ports:
+      - "${QUESTION_PORT}:${QUESTION_PORT}"
+    environment:
+      PORT: ${QUESTION_PORT}
+      DB_CLOUD_URI: ${QUESTION_DB_CLOUD_URI}     
+      DB_LOCAL_URI: ${QUESTION_DB_LOCAL_URI}    
+      ENV: ${ENV}                     
+    depends_on:
+      - question-db
+    networks:
+      - app-network
+
+  question-db:
+    image: mongodb/mongodb-atlas-local
+    ports:
+      - "27018:27018"
+    networks:
+      - app-network
+
+  user-service:
+    container_name: user-service
+    restart: on-failure
+    build: 
+      context: ./services/user-service
+      args:
+        - PORT=${USER_PORT}
+    image: ${DOCKER_USERNAME}/user-service:latest
+    ports:
+      - "${USER_PORT}:${USER_PORT}"
+    environment:
+      PORT: ${USER_PORT}
+      DB_CLOUD_URI: ${USER_DB_CLOUD_URI}     
+      DB_LOCAL_URI: ${USER_DB_LOCAL_URI}    
+      ENV: ${ENV}       
+      JWT_SECRET: ${JWT_SECRET}      
+      EMAIL_USER: ${EMAIL_USER}
+      EMAIL_PASSWORD: ${EMAIL_PASSWORD}             
+      FRONTEND_URL: ${FRONTEND_URL}             
+    depends_on:
+      - user-db
+    networks:
+      - app-network
+
+  user-db:
+    image: mongodb/mongodb-atlas-local
+    ports:
+      - "27019:27019"
+    networks:
+      - app-network
+
+  matching-service:
+    container_name: matching-service
+    restart: on-failure
+    build: 
+      context: ./services/matching-service
+      args:
+        - PORT=${MATCHING_PORT}
+        - REDIS_HOST=redis
+        - REDIS_PORT=6379
+    ports:
+      - "${MATCHING_PORT}:${MATCHING_PORT}"
+    image: ${DOCKER_USERNAME}/matching-service:latest
+    environment:
+      PORT: ${MATCHING_PORT}
+      REDIS_HOST: redis
+      REDIS_PORT: 6379
+      ENV: ${ENV}
+    depends_on:
+      - redis
+    networks:
+      - app-network
+
+  collaboration-service:
+    container_name: collaboration-service
+    restart: on-failure
+    build: 
+      context: ./services/collaboration-service
+      args:
+        - PORT=${COLLAB_PORT}
+    image: ${DOCKER_USERNAME}/collaboration-service:latest
+    ports:
+      - "${COLLAB_PORT}:${COLLAB_PORT}"
+    environment:
+      PORT: ${COLLAB_PORT}
+      HISTORY_PORT: ${HISTORY_PORT}
+      ENV: ${ENV}
+      DB_CLOUD_URI: ${COLLAB_DB_CLOUD_URI}     
+      DB_LOCAL_URI: ${COLLAB_DB_LOCAL_URI}  
+    networks:
+      - app-network
+
+  redis:
+    image: redis:alpine
+    restart: on-failure
+    ports:
+      - "6379:6379"
+    networks:
+      - app-network
+
+  api-gateway:
+    container_name: api-gateway
+    restart: on-failure
+    build:
+      context: ./services/api-gateway
+      args:
+        - PORT=${GATEWAY_PORT}
+        - QUESTION_PORT=${QUESTION_PORT}
+        - USER_PORT=${USER_PORT}
+        - COLLAB_PORT=${COLLAB_PORT}
+        - HISTORY_PORT=${HISTORY_PORT}
+        - HISTORY_URL=http://history-service
+        - USER_URL=http://user-service
+        - QUESTION_URL=http://question-service
+        - COLLAB_URL=http://collaboration-service
+    image: ${DOCKER_USERNAME}/api-gateway:latest
+    ports:
+      - "${GATEWAY_PORT}:${GATEWAY_PORT}"
+    environment:
+      PORT: ${GATEWAY_PORT}
+      QUESTION_PORT: ${QUESTION_PORT}
+      USER_PORT: ${USER_PORT}
+      COLLAB_PORT: ${COLLAB_PORT}
+      HISTORY_PORT: ${HISTORY_PORT}
+      HISTORY_URL: http://history-service
+      USER_URL: http://user-service
+      QUESTION_URL: http://question-service
+      COLLAB_URL: http://collaboration-service
+    depends_on:
+      - question-service
+      - user-service
+      - history-service
+      - collaboration-service
+    networks:
+      - app-network
+
+  frontend:
+    build: ./frontend
+    image: ${DOCKER_USERNAME}/frontend:latest
+    ports:
+      - "3000:3000" 
+    volumes:
+      - ./frontend:/app 
+      - /app/node_modules
+    depends_on:
+      - api-gateway
+    networks:
+      - app-network
+
+  history-service: 
+    container_name: history-service
+    restart: on-failure
+    build: 
+      context: ./services/history-service
+      args:
+        - PORT=${HISTORY_PORT}
+    image: ${DOCKER_USERNAME}/history-service:latest
+    ports:
+      - "${HISTORY_PORT}:${HISTORY_PORT}"
+    environment:
+      PORT: ${HISTORY_PORT}
+      QUESTION_PORT: ${QUESTION_PORT}
+      DB_CLOUD_URI: ${HISTORY_DB_CLOUD_URI}
+      DB_LOCAL_URI: ${HISTORY_DB_LOCAL_URI}
+      ENV: ${ENV}
+    depends_on:
+      - history-db
+    networks:
+      - app-network
+
+  history-db:
+    image: mongodb/mongodb-atlas-local
+    ports:
+      - "27020:27020"
+    networks:
+      - app-network
+
+networks:
+  app-network:
+    driver: bridge

frontend/.env.sample

@@ -0,0 +1,6 @@
+# Set to default ports
+REACT_APP_QUESTION_API_URL=http://localhost:3001
+REACT_APP_USER_API_URL=http://localhost:3002
+REACT_APP_MATCHING_API_URL=http://localhost:8080
+REACT_APP_COLLAB_WS_URL=ws://localhost:8081
+REACT_APP_COLLAB_API_URL=http://localhost:8081

frontend/.gitignore

@@ -0,0 +1,37 @@
+# React related
+node_modules/
+build/
+.env
+
+# Logs
+npm-debug.log
+yarn-error.log
+
+# Miscellaneous
+.DS_Store
+*.log
+*.swp
+*.tmp
+*.bak# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*