Feedback

.env.example

@@ -0,0 +1,42 @@
+# Frontend used domains (NEXTJS needs NEXT_PUBLIC_ prefix, added in docker-compose)
+API_GATEWAY_DOMAIN=http://localhost:8000/api
+FE_COLLAB_SERVICE_DOMAIN=http://localhost:8007
+FE_MATCHING_WEBSOCKET_SERVICE_DOMAIN=http://localhost:8008
+FE_CHAT_SERVICE_DOMAIN=http://localhost:8009
+
+# API Gateway
+QUESTION_SERVICE_DOMAIN=http://question-app:8001
+USER_SERVICE_DOMAIN=http://user-app:8003
+COLLAB_SERVICE_DOMAIN=http://collab-app:8007
+HISTORY_SERVICE_DOMAIN=http://history-app:8090
+
+# May not need: Not sure how to redirect socket connections
+CHAT_SERVICE_DOMAIN=http://chat-app:8009
+MATCHING_WEBSOCKET_SERVICE_DOMAIN=http://matching-websocket:8008
+# Even if redirect is possible, need "public" URL for sockets
+
+# Question Service
+MONGODB_URI=
+MONGODB_NAME=
+
+# User Service
+JWT_SECRET=you-can-replace-this-with-your-own-secret
+DB_CLOUD_URI=
+DB_LOCAL_URI=mongodb://user-service-db:27017/peerprepUserServiceDB
+PORT=8003
+ENV=DEV # or PROD to use cloud URI
+
+# History Service
+HISTORY_SERVICE_PORT=8090
+HISTORY_SERVICE_MONGODB_URI=
+
+# Kafka Cluster
+KAFKA_BROKER_URI=kafka:8005
+
+# Matching Service
+MATCHING_SERVICE_CONSUMER_GROUP_ID=matching-service
+MATCHING_WEBSOCKET_SERVICE_CONSUMER_GROUP_ID=matching-websocket-service
+REDIS_DOMAIN=redis://redis:6379
+
+# Collab Service
+COLLAB_SERVICE_CONSUMER_GROUP_ID=collab-service

.gitignore

@@ -0,0 +1,133 @@
+# macOS
+.DS_Store
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -1,7 +1,46 @@
+[![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
 
-### 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. 
+### 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.
+
+# Note when adding new services
+
+Initialising a new Nest.js project will cause a `.git` folder to exist within the service, which is not what we want. We want to remove the nested git folders by doing:
+
+1. Verify that there is a nested `.git` directory
+
+```bash
+find backend/service_name/ -name ".git"
+```
+
+2. Remove the `.git` directory.
+
+```bash
+rm -rf backend/service_name/.git
+```
+
+# Backend: Service - Port Bindings
+
+| Service                    | Docker Port | Local Port |
+| -------------------------- | ----------- | ---------- |
+| Frontend                   | 3000        | 3000       |
+| API Gateway                | 8000        | 8000       |
+| Question Service           | 8001        | 8001       |
+| Matching Service           | 8002        | 8002       |
+| User Service               | 8003        | 8003       |
+| User Service MongoDB       | 27017       | 27017      |
+| Zookeeper                  | -           | 8004       |
+| Kafka                      | -           | 8005       |
+| Collab Service             | 8007        | 8007       |
+| Matching WebSocket Service | 8008        | 8008       |
+| Chat Service               | 8009        | 8009       |
+| Kafka UI                   | 8006        | 8080       |
+| History Service            | 8090        | 8090       |
+| Redis                      | -           | 6379       |

backend/api-gateway/.env.sample

@@ -0,0 +1,2 @@
+QUESTION_SERVICE_DOMAIN=http://question-app:8001
+USER_SERVICE_DOMAIN=http://user-app:8003

backend/api-gateway/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

backend/api-gateway/.gitignore

@@ -0,0 +1,56 @@
+# compiled output
+/dist
+/node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

backend/api-gateway/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

backend/api-gateway/Dockerfile

@@ -0,0 +1,15 @@
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+RUN npm run build
+
+EXPOSE 8000
+
+CMD ["npm", "run", "start:prod"]

backend/api-gateway/Dockerfile.dev

@@ -0,0 +1,13 @@
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["npm", "run", "start:dev"]