Merge pull request #19 from CS3219-AY2425S1/rick/frontend

MS2: Set up Frontend Repo

Author: evanyan13

backend/collaboration-service/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

backend/collaboration-service/README.md

@@ -0,0 +1,44 @@
+# Real-time Messaging Server
+
+This is a simple server implementation using Socket.io for real-time messaging. The server listens for connections and emits messages to all connected clients.
+
+## Project Overview
+
+- The server is hosted on port **3000**.
+- A Next.js frontend automatically runs on port **3001**.
+- The server handles real-time connections, broadcasts messages, and manages disconnections.
+
+## How to Run
+
+1. **Clone the repository** and navigate to the project directory.
+
+2. **Install dependencies**:
+
+   ```bash
+   npm install
+   ```
+
+3. **Start the server**:
+
+   ```bash
+   npm run dev
+   ```
+
+4. The server will start on port 3000, and the Next.js frontend will automatically run on port 3001.
+
+## Server Details
+
+- **Socket.io Configuration**:
+
+  - CORS is enabled for `http://localhost:3001`.
+  - Accepts `GET` and `POST` methods.
+
+- **Events**:
+  - `connection`: Logs when a user connects.
+  - `message`: Listens for messages from clients and broadcasts them to all connected users.
+  - `disconnect`: Logs when a user disconnects.
+
+## Demo
+
+- Open your Next.js frontend on `http://localhost:3001`.
+- Send a message, and it will be broadcasted to all connected users.