From 6367b4d438ff689d9d4ff8fbd1a41876e1e6d6ee Mon Sep 17 00:00:00 2001 From: obai Albek <3009594@stud.hs-mannheim.de> Date: Sun, 14 Sep 2025 05:43:26 +0200 Subject: [PATCH] Readme file --- MyLocalChat/README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/MyLocalChat/README.md b/MyLocalChat/README.md index 20e6162..747e8d2 100644 --- a/MyLocalChat/README.md +++ b/MyLocalChat/README.md @@ -1,12 +1,25 @@ -# LocalChat 🗨 +# LocalChat 🗨️ Ein lokales Chat-System entwickelt in Java, das private Chats und Gruppenchats unterstützt. Perfect für den Einsatz in lokalen Netzwerken oder für den persönlichen Gebrauch. +## 🏗️ Architektur & Technologien + +### 🛠️ Entwicklungswerkzeuge +- **Build Tool**: Maven +- **Testing Framework**: JUnit 5 +- **Java Version**: 17+ +- **IDE**: Eclipse/IntelliJ IDEA + +### ✅ Testing Strategy +- **Unit Tests**: Für Domain-Klassen (User, Message, ChatRoom) +- **Integration Tests**: Für ChatService +- **Test Coverage**: >80% der Geschäftslogik + ## ✨ Features ### 👥 Benutzerverwaltung - **Registrierung & Login** mit eindeutigen Benutzernamen -- **Online/Offline Status** Anzeige +- **Online/Offline Status** Anzeige - **Benutzerstatus** (Verfügbar, Beschäftigt, etc.) - **Kontaktverwaltung** mit Freundesliste @@ -20,3 +33,20 @@ Ein lokales Chat-System entwickelt in Java, das private Chats und Gruppenchats u - **Admin-Berechtigungen** für Gruppenersteller - **Teilnehmer verwalten** (hinzufügen/entfernen) - **Admin-Rechte vergeben**/entziehen + +## 🚀 Installation & Start + +### Voraussetzungen +- **Java JDK 17** oder höher +- **Maven 3.6+** + +### Mit Maven builden +```bash +# Projekt kompilieren +mvn clean compile + +# Tests ausführen +mvn test + +# Anwendung starten +mvn exec:java -Dexec.mainClass="app.Main" \ No newline at end of file