Feedback

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

.github/workflows/deployment.yml

@@ -0,0 +1,92 @@
+name: CD
+
+on:
+  push:
+    branches:
+      - main
+      - 'deployment'
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-user-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected] # This is the action
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
+          heroku_app_name: 'cs3219-48-user-service' #Must be unique in Heroku
+          heroku_email: '[email protected]'
+          usedocker: true
+          appdir: 'user-service'
+
+  build-question-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected] # This is the action
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
+          heroku_app_name: 'cs3219-48-question-service' #Must be unique in Heroku
+          heroku_email: '[email protected]'
+          usedocker: true
+          appdir: 'question-service'
+
+  build-matching-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected] # This is the action
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
+          heroku_app_name: 'cs3219-48-matching-service' #Must be unique in Heroku
+          heroku_email: '[email protected]'
+          usedocker: true
+          appdir: 'matching-service'
+
+  build-communication-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected] # This is the action
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY2}}
+          heroku_app_name: 'cs3219-48-communicationservice' #Must be unique in Heroku
+          heroku_email: '[email protected]'
+          usedocker: true
+          appdir: 'communication-service'
+
+  build-collab-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected] # This is the action
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY2}}
+          heroku_app_name: 'cs3219-48-collab-service' #Must be unique in Heroku
+          heroku_email: '[email protected]'
+          usedocker: true
+          appdir: 'collab-service'
+
+  build-frontend-service:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Development Code
+        uses: actions/checkout@v2
+      - name: Use Node.js 14.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+      - run: npm install
+      - run: npm run build --if-present
+      - name: Deploy to Heroku
+        uses: akhileshns/[email protected]
+        with:
+          heroku_api_key: ${{ secrets.HEROKU_API_KEY2 }}
+          heroku_app_name: 'cs3219-48-peerprep'
+          heroku_email: '[email protected]'
+          appdir: 'frontend'

.gitignore

@@ -0,0 +1,10 @@
+node_modules/
+frontend/node_modules/
+frontend/.env
+user-service/node_modules/
+user-service/.env
+question-service/.env
+question-service/node_modules
+communication-service/node_modules
+matching-service/node_modules/
+

README.md

@@ -1,14 +1,68 @@
-# CS3219-AY22-23-Project-Skeleton
+# CS3219-AY22-23-Project - PeerPrep (Team 48)
 
-This is a template repository for CS3219 project.
+App is deployed at https://cs3219-48-peerprep.herokuapp.com/.
 
-## User Service
-1. Rename `.env.sample` file to `.env`.
-2. Create a Cloud DB URL using Mongo Atlas.
-3. Enter the DB URL created as `DB_CLOUD_URI` in `.env` file.
-4. Install npm packages using `npm i`.
-5. Run User Service using `npm run dev`.
+## Introduction
 
-## Frontend
-1. Install npm packages using `npm i`.
-2. Run Frontend using `npm start`.
+PeerPrep is a web application that helps students prepare for whiteboard style technical interviews. PeerPrep provides a peer learning platform where students can match up with peers depending on difficulty in order to practice technical interview questions. Peerprep comes with a collaborative editor, chatbox as well as a question bank that users can access to see all the available questions.
+
+## How to use Peerprep?
+
+### Prerequisite
+
+Due to the limitation of heroku free tier, please spin up the respective servers before accessing the app on the following link:
+https://cs3219-48-peerprep.herokuapp.com/ <br/>
+Frontend should show the landing page as per instructions below.
+
+https://cs3219-48-user-service.herokuapp.com/api/user <br/>
+User service should display “Hello World from user-service” if successfully loaded.
+
+https://cs3219-48-question-service.herokuapp.com/api/question <br/>
+Question service should display a JSON object with “data” as the first field.
+
+https://cs3219-48-matching-service.herokuapp.com/ <br/>
+Matching service should display “Hello World from matching-service” when successfully loaded.
+
+https://cs3219-48-collab-service.herokuapp.com/ <br/>
+Collab service should display “okay” when successfully loaded.
+
+https://cs3219-48-communicationservice.herokuapp.com/ <br/>
+Communication service should display “Hello World from communication-service” if successfully loaded.
+
+<b>Note: </b> You might need to refresh the page if heroku displays an error the first time.
+
+### Instructions
+
+1. From the landing page, click on "Start Coding".
+   ![LandingPage](./documentation/images/LandingPage.jpg)
+
+2. On the login page, if you do not have an account, click on “Create new account”.
+   ![LoginPage](./documentation/images/2.JPG)
+
+3. You will be brought to the register page. Enter the username, password and email that you would like to use, then click “Sign up”.
+   ![RegisterPage](./documentation/images/2.5.JPG)
+
+4. You should see a pop up stating a successful creation. If not, refresh the page and try again. Click “log in”. This will redirect you back to the login page.
+   ![RegisterSuccessPage](./documentation/images/3.JPG)
+
+5. Enter your username and password and click the “Log in” button.
+   ![LoginWithDetailsPage](./documentation/images/4.JPG)
+
+6. Once you are in, you should see the following matching page. Feel free to explore the various buttons but for now let’s go through how to queue for a match.
+   ![MatchingPage](./documentation/images/5.JPG)
+
+7. Select a difficulty. Here we selected “hard”. Then click the “Start Coding” button.
+   ![MatchingPageWithDifficulty](./documentation/images/6.JPG)
+
+8. The match will start and a countdown from the 30s will begin. If you have a friend, get him to queue up as well for the “hard”.
+   ![MatchingTimer](./documentation/images/7.JPG)
+
+9. Now you have successfully matched with your friend and can begin your interview preparation. The editor box on the side allows for you and your friend to code in a collaborative manner.
+   ![MatchingTimer](./documentation/images/8.JPG)
+
+10. However, if after 30s you still have yet to be matched you will be presented with 2 choices. EIther change the difficulty you are queueing for or queue again.
+    ![MatchingTimer](./documentation/images/9.JPG)
+
+### Find out more?
+
+Read our documentation [here](./documentation/48-FinalReport.pdf)!

collab-service/.dockerignore

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

collab-service/Dockerfile

@@ -0,0 +1,12 @@
+FROM node:16
+ENV NODE_ENV=production
+RUN apt-get clean && apt-get -y update && apt-get install -y locales && locale-gen en_US.UTF-8
+ENV LANG='en_US.UTF-8' LANGUAGE='en_US.UTF-8' LC_ALL='en_US.UTF-8'
+ENV DIRPATH=/path
+WORKDIR $DIRPATH/$DIRNAME
+COPY package*.json ./
+RUN npm install -g [email protected]
+RUN npm install
+COPY . .
+EXPOSE 1234
+CMD [ "npm", "run", "start" ]

collab-service/callback.js

@@ -0,0 +1,86 @@
+const http = require('http');
+
+const CALLBACK_URL = process.env.CALLBACK_URL
+  ? new URL(process.env.CALLBACK_URL)
+  : null;
+const CALLBACK_TIMEOUT = process.env.CALLBACK_TIMEOUT || 5000;
+const CALLBACK_OBJECTS = process.env.CALLBACK_OBJECTS
+  ? JSON.parse(process.env.CALLBACK_OBJECTS)
+  : {};
+
+exports.isCallbackSet = !!CALLBACK_URL;
+
+/**
+ * @param {Uint8Array} update
+ * @param {any} origin
+ * @param {WSSharedDoc} doc
+ */
+exports.callbackHandler = (update, origin, doc) => {
+  const room = doc.name;
+  const dataToSend = {
+    room,
+    data: {},
+  };
+  const sharedObjectList = Object.keys(CALLBACK_OBJECTS);
+  sharedObjectList.forEach((sharedObjectName) => {
+    const sharedObjectType = CALLBACK_OBJECTS[sharedObjectName];
+    dataToSend.data[sharedObjectName] = {
+      type: sharedObjectType,
+      content: getContent(sharedObjectName, sharedObjectType, doc).toJSON(),
+    };
+  });
+  callbackRequest(CALLBACK_URL, CALLBACK_TIMEOUT, dataToSend);
+};
+
+/**
+ * @param {URL} url
+ * @param {number} timeout
+ * @param {Object} data
+ */
+const callbackRequest = (url, timeout, data) => {
+  data = JSON.stringify(data);
+  const options = {
+    hostname: url.hostname,
+    port: url.port,
+    path: url.pathname,
+    timeout,
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Content-Length': data.length,
+    },
+  };
+  const req = http.request(options);
+  req.on('timeout', () => {
+    console.warn('Callback request timed out.');
+    req.abort();
+  });
+  req.on('error', (e) => {
+    console.error('Callback request error.', e);
+    req.abort();
+  });
+  req.write(data);
+  req.end();
+};
+
+/**
+ * @param {string} objName
+ * @param {string} objType
+ * @param {WSSharedDoc} doc
+ */
+const getContent = (objName, objType, doc) => {
+  switch (objType) {
+    case 'Array':
+      return doc.getArray(objName);
+    case 'Map':
+      return doc.getMap(objName);
+    case 'Text':
+      return doc.getText(objName);
+    case 'XmlFragment':
+      return doc.getXmlFragment(objName);
+    case 'XmlElement':
+      return doc.getXmlElement(objName);
+    default:
+      return {};
+  }
+};

collab-service/package.json

@@ -0,0 +1,13 @@
+{
+  "scripts": {
+    "dev": "node server.js",
+    "start": "node server.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "lodash.debounce": "^4.0.8",
+    "ws": "^8.10.0",
+    "y-protocols": "^1.0.5",
+    "yjs": "^13.5.42"
+  }
+}

collab-service/server.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+/**
+ * @type {any}
+ */
+const WebSocket = require("ws");
+const http = require("http");
+const wss = new WebSocket.Server({ noServer: true });
+const setupWSConnection = require("./utils.js").setupWSConnection;
+
+// const host = process.env.HOST || "localhost";
+const port = process.env.PORT || 1234;
+
+const server = http.createServer((request, response) => {
+  response.writeHead(200, { "Content-Type": "text/plain" });
+  response.end("okay");
+});
+
+wss.on("connection", setupWSConnection);
+
+server.on("upgrade", (request, socket, head) => {
+  // You may check auth of request here..
+  // See https://github.com/websockets/ws#client-authentication
+  /**
+   * @param {any} ws
+   */
+  const handleAuth = (ws) => {
+    wss.emit("connection", ws, request);
+  };
+  wss.handleUpgrade(request, socket, head, handleAuth);
+});
+
+server.listen(port, () => {
+  console.log(`running on port ${port}`);
+});