ARUNOX Framework

ARUNOX Framework Konventionen

Die Einhaltung dieser Konventionen gewährleistet eine konsistente, wartbare und erweiterbare Entwicklung innerhalb des ARUNOX-Frameworks.

1. Verzeichnisstruktur

Die Verzeichnisstruktur ist klar definiert und folgt dem Prinzip der Modularität:

/public/               // Einstiegspunkt des Frameworks
/config/               // Globale Konfigurationsdateien
/library/              // Framework-Kernbibliotheken
/plugins/              // Plugin-Logik
/themes/               // Theme-spezifische Dateien
    

Plugins und Themes haben eigene Unterstrukturen:

Plugins

/plugins//
    /library/ARUNOX/Plugins//
    /hooks/api.php
    /config.php
    

Themes

/themes//
    /library/ARUNOX/Themes//
    /templates/index.php
    /assets/
    

2. Namenskonventionen

• Namespaces: Klassen verwenden den Namespace entsprechend der Verzeichnisstruktur, z. B. ARUNOX\Core\.
• Dateinamen: Klassen verwenden CamelCase (z. B. UserAuth.php), während Verzeichnisse kleingeschrieben sind (z. B. /plugins/user/).
• Konfigurationsdateien: Klare und eindeutige Konstanten (z. B. DEBUG_MODE).

3. Kommentar-Richtlinien

Alle Dateien müssen eine einheitliche Kopfzeile enthalten:

/**
 * [Dateiname oder Namespace]
 *
 * [Kurze Beschreibung der Datei oder Klasse]
 *
 * @author          Sparky 
 * @copyright       2025 ARUNOX
 * @version         [Version der Datei]
 */
    

4. API-Konventionen

• API-Endpunkte sind versionsbasiert (z. B. /api/v1/).
• Neue API-Versionen müssen abwärtskompatibel sein.
• Routen werden dynamisch über Plugins geladen und nicht zentral definiert.

5. Plugin- und Theme-Integration

Plugins und Themes folgen einer klar definierten Struktur und bieten hohe Modularität:

• Plugin-Routen: Werden über hooks/api.php registriert.
• Theme-Overrides: Plugins können Theme-Templates überschreiben, indem sie die gleiche Struktur nutzen.

6. Tests

Tests erfolgen ausschließlich über public/tests.php. Alle anderen Zugriffe auf Test-Routinen sind untersagt.

7. Änderungen und Versionierung

• PATCH-Versionen: Werden bei jeder Änderung automatisch aktualisiert.
• MINOR-Versionen: Änderungen werden erst nach erfolgreichem Test angepasst.
• MAJOR-Versionen: Änderungen erfordern eine explizite Zustimmung und erfolgen erst nach Livegang.
• Dokumentation: Änderungen an bestehenden Dateien werden immer dokumentiert und versioniert.

8. Farbschema

Das Framework verwendet ein festgelegtes Farbschema:

• Türkis: #33abc9
• Pink: #800080
• Schwarz: als primäre Hintergrundfarbe
• Weiß: für Text und Kontraste

9. Dynamische Layouts

Themes unterstützen dynamische Layouts, die einfach angepasst werden können. Änderungen an Themes werden in der config.php des jeweiligen Themes definiert.