Installation

Das Framework kann mit dem Composer Dependency Manager installiert werden. Für den Zugriff auf die RHRZ-internen GitLab-Repositories wird die Versionsverwaltung Git benötigt. Die minimal erforderliche PHP-Version ist in der Datei composer.json vermerkt.

Installation mit git clone

1. git clone https://gitlab.rhrk.uni-kl.de/rz-webdev/meta/framework myproject
2. Den durch Git erstellten Ordner myproject öffnen.
3. Den Ordner .git löschen und ggf. durch den des eigenen Projekts ersetzen.
4. Die Datei auth.example.json in auth.json umbenennen.
5. composer install ausführen.
6. Die Datei env.example.php in env.php umbenennen.
7. Die Umgebungsvariablen in der Datei env.php konfigurieren.
   • Die Option app.env auf dev, stage oder prod setzen.
   • Bei der Option app.host die Hostnamen eintragen, auf denen die Anwendung ausgeführt werden darf.
   • Bei den db-Optionen die Verbindungsdaten für die Datenbank eintragen.

Verzeichnisse

Der Ordner public ist das Root-Verzeichnis für die Website des Projekts. Der Webserver muss so konfiguriert werden, dass alle Requests auf die Datei index.php weitergeleitet werden. Für Apache befindet sich eine entsprechende Konfiguration in der Datei .htaccess.

Falls die lokalen Strukturen erfordern, dass das Root-Verzeichnis außerhalb des Projektordners liegt, können in der Datei index.php die Konstanten INCDIR und DATADIR angepasst werden.