Bei Fragen zu Funktionalitäten und Aufbau ist die zum Projekt dazugehörige Facharbeit zu lesen. Code-spezifische Fragen sind den Kommentaren des Codes zu entnehmen. Sofern weitere Fragen offen sind, kann sich beim Autor des Projekts gemeldet werden.
Zur Weiterentwicklung des Projekts werden npm und composer benötigt.
- npm Installation: https://www.npmjs.com/get-npm
- composer Installation: https://getcomposer.org/download/
Da bei der Entwicklung dieses Projekts die PHP-Entwicklungsumgebung XAMPP genutzt wurde, wird empfohlen XAMPP weiterhin zu nutzen, um eventuelle Fehler zu vermeiden. Zudem bringt XAMPP gleich einen MySQL-Server mit, welcher auch über phpMyAdmin ohne weiteren Installationsaufwand verwaltet werden kann.
Das Projekt wurde unter PHP 7.4.10 entwickelt.
Die entsprechende XAMPP Version kann hier heruntergeladen werden. Bei der Datei handelt es sich um eine Installations-Exe.
- Gewünschter Root Ordner: https://stackoverflow.com/questions/18902887/how-to-configuring-a-xampp-web-server-for-different-root-directory
- Setup local Mail: https://sebastianviereck.de/xampp-mails-verschicken-von-localhost-mit-sendmail/
- Weitere Serveranpassungen: https://stackoverflow.com/questions/9691057/php-apache-ajax-post-limit
Mit Phing wird das Projekt in den /dist Ordner gebaut. In der build.xml ist definiert welche Dateien gebaut werden.
Siehe PHING installieren
npm node_module werden installiert mit:
$ npm run restore
Nachdem die benötigten Module installiert und zuvor PHING installiert wurden,
kann mit $ npm run build das Projekt gebaut werden. Beim Bauen werden die
CSS-Dateien und JS-Dateien minimiert gebaut und in den Ordner build kopiert.
Für die Entwicklung wurde $ npm run debug hinzugefügt. Dieses Skript baut
ebenfalls das Projekt, jedoch für die lokale Entwicklung. Die JavaScript-Dateien
werden nicht minimiert und die Dateien werden nicht in den build-Ordner kopiert.
Die CSS-Dateien werden mit Hilfe von SASS aus SCSS-Dateien gebaut. Es werden zwei Versionen an CSS-Dateien gebaut: public-styles.css und styles.css Die public-styles.css wird ausgeliefert, wenn der Benutzer nicht angemeldet ist. Die styles.css hingegen wird für angemeldete Benutzer ausgeliefert. Der Grund weshalb zwei verschiedene Dateien ausgeliefert werden ist einfach, dass nicht angemeldete Benutzer weniger Daten übertragen bekommen.
Die JS-Dateien werden mit Hilfe von Terser gebaut. Es werden zwei verschiedene Versionen gebaut: public-script.js und script.js. Die public-script.js enthält Funktionalitäten, welche jeder Benutzer nutzen darf. Die script.js enthält alle Funktionalitäten des Frontends und ist wird nur für angemeldete Benutzer ausgeliefert. Der Grund für diese Unterscheidung ist einerseits, dass nicht angemeldete Benutzer weniger Daten transferiert bekommen und andererseits, dass die Anwendung sicherer ist.
PHPDOC wird verwendet, um eine strukturierte Übersicht über die Codedoku zu haben.
https://docs.phpdoc.org/guide/getting-started/installing.html
Falls PHP mit composer installiert wurde, muss die Datei vendor/phpdocumentor/phpdocumentor/bin/phpdoc.bat bearbeitet werden (Fehler seitens PHPDOC, Stand: 12.10.2020). Den Code der Datei mit den folgenden Zeilen ersetzen:
@echo off
if "%PHPBIN%" == "" set PHPBIN=php.exe
if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH
GOTO RUN
:USE_PEAR_PATH
set PHPBIN=%PHP_PEAR_PHP_BIN%
:RUN
"%PHPBIN%" "phpdoc" %*
Mit $ npm run phpdoc wird phpdoc zur Erstellung einer PHP Dokumentation aus
dem Code ausgeführt.
Die erstellte PHP Dokumentation ist unter /docs/index.html zu finden.
- Fehler der Planung aus automatischer Suche nach Richtlinienverstöße als Popup
- Undo und Redo der letzten nicht gespeicherten Änderungen auf Oberfläche
- Deutsches Language-Pack auf Server für PHP installieren
- Automatisierte Planung immer weiter verbessern
- Druckversion optimieren: Filterung und Spalten umschalten mit über + nur bestimmte Zeiträume drucken
- Tabelle optimieren: zu viele Elemente (Table Cells) werden gerendert
- PWA: Letzte Planung cachen für Offline-Mode