Feedback

.env.example

@@ -0,0 +1,13 @@
+UI_PORT=3000
+USER_SERVICE_PORT=3001
+MATCHING_SERVICE_PORT=3002
+QUESTION_SERVICE_PORT=3003
+COLLABORATION_SERVICE_PORT=3004
+BASE_URL=localhost
+
+REDIS_HOST=host.docker.internal
+REDIS_PORT=6379
+REDIS_PASSWORD=password
+
+JWT_ACCESS_SECRET=
+JWT_REFRESH_SECRET=

.gitignore

@@ -0,0 +1,5 @@
+.env
+redis_data
+redis_data_build
+mongo_data
+mongo_data_build

README.md

@@ -1,5 +1,24 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/QUdQy4ix)
 # CS3219 Project (PeerPrep) - AY2526S1
-## Group: Gxx
+## Group: G31
+
+## Set up
+Each microservice has its own `README.md` file with instructions on how to set up and run the microservice individually. Please refer to those files for individual microservice setup.
+
+1. `npm install -g yarn`
+2. run `yarn install` in shared folder first before setting up the rest of the microservices.
+
+## Running with Docker
+Copy `.env.example` to `.env` and modify the environment variables as needed.
+
+```
+docker compose build --no-cache
+docker compose up
+```
+
+## Development
+- For testing individual microservices, navigate to the respective microservice folder and follow the instructions in the `README.md` file of that microservice.
+- Hot reload is not supported when running with Docker. For hot reload during development, you can run the microservices individually as described in their respective `README.md` files.
 
 ### Note: 
 - You are required to develop individual microservices within separate folders within this repository.

collaboration-service/.gitignore

@@ -0,0 +1,171 @@
+# 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.*
+
+# TypeScript build output
+dist/
+build/
+
+# Database files
+*.db
+*.sqlite
+*.sqlite3
+
+# IDE and Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temporary files
+temp/
+tmp/
+*.tmp
+
+# Test coverage
+coverage/
+
+# Backup files
+*.bak
+*.backup
+
+# Lock files (uncomment if you want to ignore them)
+# package-lock.json
+# yarn.lock

collaboration-service/Dockerfile

@@ -0,0 +1,25 @@
+FROM node:20-alpine AS builder
+
+WORKDIR /app
+
+COPY ./shared/ ./shared/
+COPY ./collaboration-service/ ./collaboration-service/
+
+WORKDIR /app/collaboration-service
+
+RUN yarn shared
+RUN yarn install
+RUN yarn build
+
+FROM node:20-alpine AS runner
+
+WORKDIR /app/collaboration-service
+
+COPY --from=builder /app/collaboration-service/dist ./dist
+COPY --from=builder /app/collaboration-service/node_modules ./node_modules
+COPY --from=builder /app/collaboration-service/package.json ./package.json
+COPY --from=builder /app/collaboration-service/yarn.lock ./yarn.lock
+
+EXPOSE 3004
+
+CMD ["yarn", "start"]

collaboration-service/README.md

@@ -0,0 +1,9 @@
+### Collaboration Service
+Responsible for facilitating collaboration between users, including features like chat, file sharing, and real-time editing.
+
+Provides the mechanism for real-time collaboration (e.g., concurrent code editing) between the authenticated and matched users in the collaborative space.
+
+### Set up
+1. `npm install -g yarn`
+2. `yarn install`
+3. `yarn run dev` to start the development server.

collaboration-service/nodemon.json

@@ -0,0 +1,10 @@
+{
+    "watch": [
+        "src"
+    ],
+    "ignore": [
+        "src/**/*.spec.ts"
+    ],
+    "ext": "ts, html, css, ejs, json",
+    "exec": "ts-node ./src/index.ts"
+}

collaboration-service/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "collaboration-service",
+  "version": "1.0.0",
+  "main": "./src/index.ts",
+  "license": "MIT",
+  "scripts": {
+    "shared": "yarn --cwd ../shared install && yarn --cwd ../shared build && yarn add file:../shared --force",
+    "dev": "nodemon",
+    "build": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "dotenv": "^17.2.2",
+    "express": "^5.1.0",
+    "shared": "file:../shared",
+    "socket.io": "^4.8.1",
+    "socket.io-client": "^4.8.1"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.3",
+    "nodemon": "^3.1.10",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2"
+  }
+}

collaboration-service/src/index.ts

@@ -0,0 +1,17 @@
+import dotenv from "dotenv";
+import path from "path";
+dotenv.config({ path: path.resolve(__dirname, "../../.env") });
+
+import http from "http";
+import app from "./server";
+import { initializeSocketServer } from "./socketServer";
+
+
+const PORT = process.env.COLLABORATION_SERVICE_PORT || 3004;
+const server = http.createServer(app);
+
+initializeSocketServer(server);
+
+server.listen(PORT, () => {
+    console.log(`Collaboration Service is running on port ${PORT}`);
+});

collaboration-service/src/model/publicUser.ts

@@ -0,0 +1,5 @@
+export interface PublicUser {
+    id: string;
+    displayName?: string;
+    picture?: string;
+}

collaboration-service/src/model/room.ts

@@ -0,0 +1,10 @@
+import { Question } from "shared";
+import { PublicUser } from "./publicUser";
+
+export interface RoomPayload {
+    roomId: string;
+    users: PublicUser[];
+    question: Question;
+    createdAt: number;
+    lastActiveAt: number;
+}

collaboration-service/src/server.ts

@@ -0,0 +1,18 @@
+import express from "express";
+import type { Request, Response } from "express";
+import { RoomPayload } from "./model/room";
+
+const app = express();
+app.use(express.json());
+
+app.get("/", (req: Request, res: Response) => {
+    res.send("Collaboration Service is running!");
+});
+
+app.post("/api/room/create", (req: Request, res: Response) => {
+    const payload = req.body as RoomPayload;
+    console.log("Room created:", payload.roomId, payload.users);
+    res.status(200).send("Room initialized");
+});
+
+export default app;