Feedback

.gitignore

@@ -0,0 +1 @@
+backend/question-backend/.env.local

README.md

@@ -1,7 +1,37 @@
+[![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: G34
+PeerPrep is a web application aimed to help students prepare for technical whiteboard interviews through peer-to-peer practice in a collaborative space.
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Architecture Overview](#architecture-overview)
+- [Project Setup](#project-setup)
+  - [Prerequisites](#prerequisites)
+  - [Instructions](#instructions)
+
+## Architecture Overview
+PeerPrep's architecture combines a scalable, microservices-based backend with a monolithic frontend, allowing for flexible backend operations and simpler frontend maintenance. Its backend is developed with Node.js and Express, while the frontend is built using React.js.
+
+<img src='./frontend/src/assets/architecture.PNG'>
+
+## Project Setup
+
+In this section, you will set up PeerPrep to run locally.
+
+### Prerequisites
+1. [Docker](https://docs.docker.com/get-docker/) installed on your machine
+2. [docker-compose](https://docs.docker.com/compose/install/) installed
+
+### Instructions
+1. Clone this repository into your local machine.
+2. Configure `.env` files as required.
+3. Navigate to the root directory of this repository (where `docker-compose.yaml` is located).
+4. Run `docker-compose` to build and run all the services.
+
+    ``` bash
+    docker-compose up --build
+    ```
+5. Once started, open up your browser and go to http://localhost:3000/ to access PeerPrep.

backend/collab-backend/.dockerignore

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

backend/collab-backend/.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+
+.DS_Store
+.env

backend/collab-backend/Dockerfile

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

backend/collab-backend/index.js

@@ -0,0 +1,89 @@
+require('dotenv').config();
+const { OpenAI } = require('openai');
+
+const express = require('express');
+const cors = require('cors');
+const dotenv = require('dotenv');
+const { createServer } = require('http');
+const { Server } = require('socket.io');
+const WebSocket = require('ws');
+const setupWSConnection = require('y-websocket/bin/utils').setupWSConnection;
+const handleSocketEvents = require('./socketHandlers');
+
+dotenv.config();
+
+const app = express();
+app.use(cors());
+app.use(express.json());
+
+// Port configurations
+const { SOCKET_IO_PORT, YJS_PORT } = process.env;
+
+// Initialize OpenAI client
+const openai = new OpenAI({
+    apiKey: process.env.OPENAI_API_KEY, // Ensure your API key is set in .env
+});
+
+// Example: Defining a POST route at /chat
+app.post('/chat', async (req, res) => {
+    const { message } = req.body;
+
+    if (!message) {
+        return res.status(400).json({ error: 'Message is required' });
+    }
+
+    try {
+        const response = await openai.chat.completions.create({
+            model: 'gpt-3.5-turbo',  // Adjust model name if necessary
+            messages: [{ role: 'user', content: message }],
+        });
+
+        const chatbotReply = response.choices[0].message.content;
+        res.json({ reply: chatbotReply });
+
+    } catch (error) {
+        console.error('OpenAI API Error:', error);  // Log the error details
+
+        // Respond with a more detailed error message if needed
+        res.status(500).json({
+            error: 'An error occurred while processing your request',
+            details: error.message  // Include error details for more insight
+        });
+    }
+});
+
+// Server setup for Socket.IO
+const ioServer = createServer(app);
+const io = new Server(ioServer, {
+    path: "/socket.io",
+    cors: { origin: 'http://localhost:3000' },
+});
+
+handleSocketEvents(io);
+
+ioServer.listen(SOCKET_IO_PORT, () => {
+    console.log(`Socket.IO server listening at http://localhost:${SOCKET_IO_PORT}`);
+});
+
+// Server setup for y-websocket
+const yjsServer = createServer(app);
+const wss = new WebSocket.Server({ noServer: true });
+
+yjsServer.on('upgrade', (request, socket, head) => {
+    if (request.url.startsWith('/yjs')) {
+        wss.handleUpgrade(request, socket, head, (ws) => {
+            wss.emit('connection', ws, request);
+        });
+    } else {
+        socket.destroy();
+    }
+});
+
+wss.on('connection', (ws, req) => {
+    console.log("WebSocket client connected for y-websocket");
+    setupWSConnection(ws, req);
+});
+
+yjsServer.listen(YJS_PORT, () => {
+    console.log(`y-websocket server listening at http://localhost:${YJS_PORT}`);
+});