# Projekt-Dokumentation ## Übersicht Willkommen zur Dokumentation des Projekts. Diese Dokumentation dient als zentrale Informationsquelle für Entwickler, die am Projekt arbeiten. ## Inhaltsverzeichnis ### Standards und Guidelines - [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) - Allgemeine Coding-Standards für das Projekt - [Sicherheitsrichtlinien](/docs/standards/SICHERHEITS-GUIDELINES.md) - Standards für sichere Softwareentwicklung ### Entwicklungsrichtlinien - [Performance Guidelines](/docs/guidelines/PERFORMANCE-GUIDELINES.md) - Richtlinien zur Optimierung der Anwendungsleistung - [Testing Guidelines](/docs/guidelines/TESTING-GUIDELINES.md) - Standards und Best Practices für Tests ### KI-Assistent Konfiguration - [Guidelines für KI-Assistenten](/docs/ai/GUIDELINES-FÜR-AI-ASSISTANT.md) - Spezifische Richtlinien für den KI-Assistenten - [PhpStorm Einrichtung](/docs/ai/EINRICHTUNG-PHPSTORM.md) - Anleitung zur Einrichtung des KI-Assistenten in PhpStorm ### Architektur und Struktur - [Projektstruktur](/docs/architecture/STRUKTUR-DOKUMENTATION.md) - Überblick über die Struktur des Projekts ### Framework-Entwicklung - [Modul-Checkliste](/docs/framework/MODUL-CHECKLISTE.md) - Leitfaden für die Erstellung neuer Module - [Erweiterungsmuster](/docs/framework/ERWEITERUNGSPATTERN.md) - Muster zur Erweiterung des Frameworks ### Framework-Module - [Analytics-Modul](/docs/framework/analytics/README.md) - Tracking und Analyse von Anwendungsdaten - [Core-Modul](/docs/framework/core/README.md) - Kernkomponenten und Event-System - [DI-Modul](/docs/framework/di/README.md) - Dependency-Injection-Container - [HTTP-Modul](/docs/framework/http/README.md) - HTTP-Request und -Response-Handling ## Mitwirken ### Neue Module entwickeln 1. Folge der [Framework-Modul Checkliste](/docs/framework/MODUL-CHECKLISTE.md) für neue Module 2. Stelle sicher, dass dein Code den [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) entspricht 3. Schreibe Tests gemäß den [Testing Guidelines](/docs/guidelines/TESTING-GUIDELINES.md) 4. Erstelle eine ausführliche Dokumentation für dein Modul ### Dokumentation verbessern Wir begrüßen Beiträge zur Verbesserung der Dokumentation. Wenn du Fehler findest oder Vorschläge zur Verbesserung hast, erstelle bitte einen Pull Request mit deinen Änderungen. ## Erste Schritte Neue Entwickler sollten mit folgenden Schritten beginnen: 1. Projekt lokal einrichten (siehe [Installation](#installation)) 2. Die [Projektstruktur](/docs/architecture/STRUKTUR-DOKUMENTATION.md) verstehen 3. Die [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) lesen 4. PhpStorm mit dem [KI-Assistenten einrichten](/docs/ai/EINRICHTUNG-PHPSTORM.md) ## Installation ```bash # Repository klonen git clone [repository-url] # Abhängigkeiten installieren composer install # Entwicklungsserver starten php -S localhost:8000 -t public/ ``` ## Updates und Änderungen Diese Dokumentation wird kontinuierlich aktualisiert. Prüfe regelmäßig auf Aktualisierungen, um über die neuesten Best Practices und Standards informiert zu bleiben.