VDOLog · Funkprotokollierung

Eine Software zur Begleitung der Funkleitstelle von Veranstaltungen.

Diese README ist für die Entwicklungsversion v2.x - Die README für die Version v1.x findet sich hier

Funktionalitäten

• Erstellung von Veranstaltungen
• Führung eines Funkprotokolls (Sender / Empfänger) zu jeder Veranstaltung
• Export des Funkprotokolls in eine Excel-Datei
• Bereitstellung über PHPDesktop als lokale Desktopapplikation

Entwicklung / Roadmap

Die Software wird aktuell im Funkleitstand des Fussball-Bundesligisten Hertha BSC verwendet und ist daher auch auf die dortigen Bedüfnisse zugeschnitten. Aktuell sieht die Idee der Software die folgenden zusätzlichen Funktionalitäten vor.

• Übersichtskarten von Veranstaltungsorten mit der Möglichkeit Sektoren einzuzeichnen
• Übersicht von vorhandenen Ordnergruppen und ihrem Standort
• Einfaches verschieben von Ordnergruppen mit automatischer Protkollierung
• Übersetzung der Software in andere Sprachen

Verwendung als Docker-Environment

Die Applikation unterstützt die Arbeit in einer Docker-Container-Umgebung. Diese Umgebung erfordert keinerlei PHP-Abhängigkeiten auf einem Host-System, so dass unabhängig vom Host die Applikation ausgeführt werden kann.

Dafür ist das Programm Docker ebenso wie Docker Compose auf dem Host-System nötig. Die Applikation kann dann folgendermaßen ausgeführt und über die Adresse http://localhost:8080 ausgeführt werden.

Verwendung als Desktopapplikation (Windows)

Für die Verwendung der Desktopversion ist ein Download des fertigen PHPDesktop-Paketes nötig. Die letzte stabile Version findet sich auf der Übersichtsseite der Releases und kann als Anhang der Version im ZIP-Format gefunden werden.

Nachdem die anhängende PHPDesktop.zip-Datei heruntergeladen und entpackt wurde findet sich im Zielverzeichnis die ausführbare Datei phpdesktop-chrome.php, welche die Applikation startet und in einem Chrome bereitstellt. Es ist nicht nötig zuvor Chrome zu installieren, der Browser wird mitgeliefert.

Eine Installation, die Einrichtung einer Datenbank oder eines Webservers sind für die Verwendung nicht nötig. Durch den Einsatz einer SQLite-Datenbank, welche sich im Verzeichnis var/data findet, bestehen neben einem aktuellen Windows keine weiteren Abhängigkeiten.

Verwendung als Serverversion

Für die Verwendung als Serverversion kann man die benötigte Version von den letzten Releases, welche man auf der Übersichtsseite der Releases findet, herunterladen. Der gesamte Sourcecode muss auf einem Server mit wenigstens PHP 8 installiert werden.

Eine Hilfe wie man einen Webserver für eine Symfony-Applikation einrichtet findet sich in der Dokumentation von Symfony.

Um das Projekt über den Sourcecode zu installieren sind folgende Schritte nötig:

# Installation aller PHP Abhängigkeiten
composer install --optimize-autoloader --no-dev --prefer-dist --no-plugins --no-scripts --no-progress

# Einrichtung einer initialen Datenbank
php bin/console doctrine:database:create
php bin/console doctrine:schema:create
php bin/console doctrine:schema:update --force

# Installation aller Frontend Abhängigkeiten
yarn install
yarn run prod

Verwendung des aktuellen Entwicklungsstandes

Für experimentelle Zwecke ist es möglich den letzten Entwicklungsstand nicht nur als Sourcecodeversion, sondern auch als Windowsversion zu verwenden. Die letzte mögliche Windowsversion findet sich unter den aktuellen Builds. Hier hängt die Datei VDOLog-PHPDesktop an jeder Änderung des Entwicklungszweiges an.

Anpassung der Konfiguration für Titel und Logo

Die Datei settings.json findet sich im Stammverzeichnis der Windowsversion. Für die Verwendung mit einem Webserver liegt die Datei unter dem Pfad config/phpdesktop/settings.json.

Relevant für die Anpassung an den eigenen Veranstalter sind folgende Einstellungen:

{
  "main_window": {
    "title": "Hertha BSC Protokoll VDO-Edition", 
    "footer_image": "/images/hertha_96x96.png",
    "footer_image_title": "Hertha BSC Logo",
    "icon": "www/public/favicon.ico"
  }
}

Danksagung und Lizenz

VDOLog © 2019+, Denis Zunke. Veröffentlicht mit der MIT Lizenz.

GitHub @dzunke  ·  Twitter @DZunke

Hertha BSC  ·  PHPDesktop  ·  tabler.io