From 188b93b56d4813e65d2c52840b787c59b904b38d Mon Sep 17 00:00:00 2001
From: Mona Schulz <ugrwh@student.kit.edu>
Date: Mon, 24 Mar 2025 09:55:11 +0000
Subject: [PATCH] Edit README.md

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d2be07d..f59711c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,29 @@
-# Collab Space
+# Collab Space Extension
+
+This project is a fork from [KIT-PSE/collab-space-app](https://github.com/KIT-PSE/collab-space-app) that includes an extension for a Teacher Dashboard. The Teacher Dashboard provides educators with insights into how students engage in different modes during a room session. It also assigns various roles to students based on their activities.
+
+The role assignment is determined through activity tracking, such as audio interactions, note-taking, and other participation metrics. A gamification-based point system evaluates these activities, which then influences the assignment of roles and modes.
+
+The primary goal of this extension is to help teachers better understand how well students collaborate in group work while identifying their strengths and areas for improvement.
+
+## Technologies
+
+- Frontend: Web Application
+  - Vue.js (with Composition API and script setup)
+  - Pinia (for state management)
+  - Type Script
+  - SCSS (Styling)
+  - Socket.io (For WebSockets)
+- Backend:
+  - NestJS 
+  - Typescript
+- Database: 
+  - MySQL
+  - MikroORM (with migrations and seeding)
+- Containerization: Docker
+- CI/CD-Pipelines: Github Actions
+- Package Manager: Node.js
+
 
 ## Benötigte Anwendungen
 - [git](https://git-scm.com/download/win)
@@ -89,7 +114,7 @@ Ausgangspunkt: Git, Docker & WSL2 installiert
   - `cat ~/.ssh/id_ed25519.pub` - Die Ausgabe dieses Commands in die Zwischenablage kopieren
   - Github Account Einstellungen öffnen -> Auf `SSH and GPG keys` klicken -> Neuen SSH key erstellen und eben kopierten Text einfügen
 - In das Verzeichnis wechseln, in welches die Repository gespeichert werden soll
-- `git clone --recurse-submodules git@github.com:KIT-PSE/collab-space-app.git`
+- `git clone --recurse-submodules git@gitlab.kit.edu:ugrwh/collabspace.git`
 - `cd collab-space-app`
 - `./init.sh`
 - `docker compose up`
-- 
GitLab