Feedback

.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+*/node_modules
+node_modules
+*/.pnp
+*.pnp.js
+
+# testing
+*/coverage
+
+# production
+*/build
+
+
+gcp-service-account-key.json
+# testing prod
+# cloudbuild.test.yaml
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*/.env
+.env
+
+gcp-service-account-key.json

README.md

@@ -1 +1,98 @@
-# AssignmentTemplate
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/6BOvYMwN)
+
+# 👋 Welcome to PeerPrep! 👋
+
+ Hello and welcome to the GitHub repository for PeerPrep, a collaborative platform dedicated to empowering and connecting learners from around the globe! This is done by Group G06 for CS3219 in AY23/24 Semester 1!
+
+### What is PeerPrep?
+PeerPrep is an innovative platform designed to enhance your learning journey through collaborative preparation. Whether you're gearing up for exams, mastering a new subject, or simply quenching your thirst for knowledge, PeerPrep is here to make the process interactive, effective, and enjoyable.
+
+Check out our deployment of the code on [GCP](https://fe-a2rwifv3ta-dt.a.run.app/)!
+
+---
+
+> **[ IMPORTANT FOR NUS CONNECTIONS!]**\
+> If you are connected to the NUS Campus Network (either directly or indirectly), you will not be able to connect to MongoDB Atlas and Google Cloud SQL, which is required by our application. You can circumvent this by going through a VPN.
+
+# Application Installation and Setup
+
+Click for instructions for the respective modes:
+
+- [Running Locally](docs/RunningLocally.md)
+- [Running on Docker](docs/RunningOnDocker.md)
+
+# Resources for Developer / Tester
+
+## Software
+
+For development, you may also want to install or subscribe to:
+
+- [Docker Desktop](https://www.docker.com/get-started/)
+- [Postman](https://www.postman.com/downloads/)
+- [MySQLWorkBench](https://dev.mysql.com/downloads/workbench/)
+- [NodeJS](https://nodejs.org/en/download)
+- [MySQL](https://dev.mysql.com/downloads/mysql/)
+- [OneCompiler on RapidAPI](https://rapidapi.com/onecompiler-onecompiler-default/api/onecompiler-apis/)
+
+## Documentation
+
+- [API Endpoints](docs/APIEndpoints.md)
+
+## Microservices
+These are the microservices we defined for our application. Each microservice is a separate folder. You can start individual services separately to test, but there are dependencies among the services, they might not function as expected on it's own.
+
+- [User Service](user-service)
+- [Matching Service](matching-service)
+- [Question Service](question-service)
+- [Frontend](frontend)
+
+To run User-Service
+1. `cd user-service`
+2. `npm install`
+3. `nodemon server.js`
+
+To run Matching-Service
+1. `cd matching-service`
+2. `npm install`
+3. `nodemon server.js`
+
+To run Question-Service
+1. `cd question-service`
+2. `npm install`
+3. `nodemon server.js`
+
+To run Frontend
+1. `cd frontend`
+2. `npm install`
+3. `npm start`
+
+---
+
+<div align="center">
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/axios.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/docker-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/express.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/google-cloud.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/google-cloud-functions.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/google-cloud-run.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/javascript.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/jwt-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/material-ui.svg"/>
+  <img width="55" height="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/mongodb-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/mysql-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/nodejs-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/nodemon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/postman-icon.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/react.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/react-router.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/socket.io.svg"/>
+  <img width="55" src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/typescript-icon.svg"/>
+</div>
+
+
+---
+🌟 Don't forget to star the repo if you find PeerPrep exciting and useful!
+
+Thank you for visiting, and happy coding!
+
+-CS3219 Team G06

cloudbuild.test.yaml

@@ -0,0 +1,89 @@
+steps:
+# Build the user-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/user-service-test:$COMMIT_SHA', 
+  '-f', './user-service/Dockerfile.prod',
+  './user-service']
+
+# Push the user-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/user-service-test:$COMMIT_SHA']
+
+# Deploy the user-service to Cloud Run
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_USR_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/user-service-test:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_USER_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build the question-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/question-service-test:$COMMIT_SHA', 
+  '-f', './question-service/Dockerfile.prod',
+  './question-service']
+
+# Push the question-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/question-service-test:$COMMIT_SHA']
+
+# Deploy question-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_QN_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/question-service-test:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_QN_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build matching-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/matching-service-test:$COMMIT_SHA', 
+  '-f', './matching-service/Dockerfile.prod',
+  './matching-service']
+
+# Push the matching-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/matching-service-test:$COMMIT_SHA']
+
+# Deploy matching-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_MS_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/matching-service-test:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_MS_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build the frontend service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/frontend-service-test:$COMMIT_SHA', 
+  # specifiy which dockerfile to use
+  '-f', './frontend/Dockerfile.stage',
+  './frontend'
+  ]
+
+# Push the frontend-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/frontend-service-test:$COMMIT_SHA']
+
+# Deploy frontend-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_FE_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/frontend-service-test:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_FE_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Images to store in Container Registry
+images:
+- 'gcr.io/$PROJECT_ID/user-service-test:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/question-service-test:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/matching-service-test:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/frontend-service-test:$COMMIT_SHA'

cloudbuild.yaml

@@ -0,0 +1,89 @@
+steps:
+# Build the user-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/user-service:$COMMIT_SHA', 
+  '-f', './user-service/Dockerfile.prod',
+  './user-service']
+
+# Push the user-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/user-service:$COMMIT_SHA']
+
+# Deploy the user-service to Cloud Run
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_USR_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/user-service:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_USER_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build the question-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/question-service:$COMMIT_SHA', 
+  '-f', './question-service/Dockerfile.prod',
+  './question-service']
+
+# Push the question-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/question-service:$COMMIT_SHA']
+
+# Deploy question-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_QN_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/question-service:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_QN_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build matching-service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/matching-service:$COMMIT_SHA', 
+  '-f', './matching-service/Dockerfile.prod',
+  './matching-service']
+
+# Push the matching-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/matching-service:$COMMIT_SHA']
+
+# Deploy matching-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_MS_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/matching-service:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_MS_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Build the frontend service
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['build', '-t', 'gcr.io/$PROJECT_ID/frontend-service:$COMMIT_SHA', 
+  # specifiy which dockerfile to use
+  '-f', './frontend/Dockerfile.prod',
+  './frontend'
+  ]
+
+# Push the frontend-service image to Container Registry
+- name: 'gcr.io/cloud-builders/docker'
+  args: ['push', 'gcr.io/$PROJECT_ID/frontend-service:$COMMIT_SHA']
+
+# Deploy frontend-service
+- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+  entrypoint: gcloud
+  args: ['run', 'deploy', '${_FE_CLOUD_RUN_NAME}', 
+  '--image', 'gcr.io/$PROJECT_ID/frontend-service:$COMMIT_SHA', 
+  '--region', '${_REGION}',
+  '--port', '${_FE_PORT}',
+  "--allow-unauthenticated"
+  ]
+
+# Images to store in Container Registry
+images:
+- 'gcr.io/$PROJECT_ID/user-service:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/question-service:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/matching-service:$COMMIT_SHA'
+- 'gcr.io/$PROJECT_ID/frontend-service:$COMMIT_SHA'

docker-compose.yml

@@ -0,0 +1,71 @@
+version: "3"
+
+services:
+  user-service:
+    build:
+      context: ./user-service
+    environment:
+      - USR_SVC_PORT=${USR_SVC_PORT}
+      - SQL_HOST=${SQL_HOST}
+      - SQL_USERNAME=${SQL_USERNAME}
+      - SQL_PASSWORD=${SQL_PASSWORD}
+      - JWT_SECRET=${JWT_SECRET}
+    ports:
+      - 3003:3003
+    networks:
+      - service
+
+  question-service:
+    build:
+      context: ./question-service
+    environment:
+      - USR_SVC_AUTH=http://user-service:3003/api/auth
+      - QNS_SVC_PORT=${QNS_SVC_PORT}
+      - MONGO_HOST=${MONGO_HOST}
+      - MONGO_USERNAME=${MONGO_USERNAME}
+      - MONGO_PASSWORD=${MONGO_PASSWORD}
+    ports:
+      - 3000:3000
+    depends_on:
+      - user-service
+    networks:
+      - service
+
+  matching-service:
+    build:
+      context: ./matching-service
+    environment:
+      - QNS_SVC=http://question-service:3000/api/questions
+      - USR_SVC_AUTH=http://user-service:3003/api/auth
+      - MTC_SVC_PORT=${MTC_SVC_PORT}
+      - JWT_SECRET=${JWT_SECRET}
+      - CDEX_KEY=${CDEX_KEY}
+      - CDEX_HOST=${CDEX_HOST}
+    ports:
+      - 3002:3002
+    depends_on:
+      - user-service
+      - question-service
+    networks:
+      - service
+
+  frontend:
+    build:
+      context: ./frontend
+    ports:
+      - 3001:3001
+    environment: 
+      - REACT_APP_QNS_SVC=http://localhost:3000/api/questions
+      - REACT_APP_MTC_SVC=http://localhost:3002
+      - REACT_APP_USR_SVC_HIST=http://localhost:3003/api/hist
+      - REACT_APP_USR_SVC_AUTH=http://localhost:3003/api/auth
+      - REACT_APP_USR_SVC_USER=http://localhost:3003/api/user
+    depends_on:
+      - user-service
+      - question-service
+      - matching-service
+    networks:
+      - service
+networks:
+  service:
+    driver: bridge