Feedback

README.md

@@ -1,7 +1,21 @@
+[![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. 
+## Group: G48
+
+### 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.
+
+### Quick start guide
+
+#### Run app with docker
+
+- Read the guides of the backend services and frontend services to setup the .env file.
+- For each service, copy the .env.sample file and rename it to .env
+- For the `user` and `question` service, update the `MONGODB_CLOUD_URI` with ur mongodb atlas uri if you are using `PROD` mode.
+- To start the app, `cd` to the backend folder and run the command `docker compose up`.
+- To stop the app, run the command `docker compose down`.

backend/CollaborationService/.dockerignore

@@ -0,0 +1 @@
+node_modules

backend/CollaborationService/.env.example

@@ -0,0 +1,9 @@
+PORT=3004
+FRONTEND_URL='http://localhost:5173'
+USER_SERVICE=http://user-service:3001 
+
+REDIS_URL='redis://redis:6379'
+# REDIS_HOST='redis'
+# REDIS_PORT='6379'
+
+ENV="DEV" # dev will use hosted service, prod uses cloud

backend/CollaborationService/.gitignore

@@ -0,0 +1,2 @@
+**/node_modules
+**/.env

backend/CollaborationService/dist/index.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+// const server = http.createServer();
+const app = (0, express_1.default)();
+// The updates received so far (updates.length gives the current
+// version)
+// let updates: Update[] = [];
+// // The current document
+// let doc = Text.of(["Start document"]);
+// let pending: ((value: any) => void)[] = [];
+// let io = new Server(server, {
+//   path: "/api",
+//   cors: {
+//     origin: "*",
+//     methods: ["GET", "POST"],
+//   },
+// });
+// // listening for connections from clients
+// io.on("connection", (socket: Socket) => {
+//   socket.on("pullUpdates", (version: number) => {
+//     if (version < updates.length) {
+//       socket.emit("pullUpdateResponse", JSON.stringify(updates.slice(version)));
+//     } else {
+//       pending.push((updates) => {
+//         socket.emit(
+//           "pullUpdateResponse",
+//           JSON.stringify(updates.slice(version))
+//         );
+//       });
+//     }
+//   });
+//   socket.on("pushUpdates", (version, docUpdates) => {
+//     docUpdates = JSON.parse(docUpdates);
+//     try {
+//       if (version != updates.length) {
+//         socket.emit("pushUpdateResponse", false);
+//       } else {
+//         for (let update of docUpdates) {
+//           // Convert the JSON representation to an actual ChangeSet
+//           // instance
+//           let changes = ChangeSet.fromJSON(update.changes);
+//           updates.push({ changes, clientID: update.clientID });
+//           doc = changes.apply(doc);
+//         }
+//         socket.emit("pushUpdateResponse", true);
+//         while (pending.length) pending.pop()!(updates);
+//       }
+//     } catch (error) {
+//       console.error(error);
+//     }
+//   });
+//   socket.on("getDocument", () => {
+//     socket.emit("getDocumentResponse", updates.length, doc.toString());
+//   });
+// });
+// const port = process.env.PORT || 3000;
+// server.listen(port, () => console.log(`Server listening on port: ${port}`));
+app.use(express_1.default.json());
+app.use(express_1.default.urlencoded({ extended: true }));
+app.get("/", (req, res) => {
+    res.send("Hello World!");
+});

backend/CollaborationService/dockerfile

@@ -0,0 +1,20 @@
+# Use an official Node.js runtime as a parent image
+FROM node:20-alpine
+
+# Set the working directory in the container
+WORKDIR /app
+
+# Copy package.json and package-lock.json
+COPY package*.json ./
+
+# Install any dependencies
+RUN npm install
+
+# Bundle app source inside the Docker image
+COPY . .
+
+# Make port 5173 available to the world outside this container
+EXPOSE 3004
+
+# Define the command to run your app
+CMD ["npm", "run", "dev"]