Readme in Deutsch | Readme in English

CharitySwimRun

24h-Schwimmen, 12h-Schwimmen, Benefiz-Schwimmen, Spendenschwimmen oder -Läufe können mit dieser kostenlosen OpenSource-Software abgewickelt werden. Teilnehmer verwalten, Bahnen/Runden zählen, Ergebnisse auswerten und Urkunden drucken sind nur einige der Möglichkeiten. Gedacht ist die Software für den temporären Einsatz auf einem Webserver in einem lokalen Netzwerk. Durch die Software, findet eine entsprechende Veranstaltung praktisch papierlos statt. Das Einrichten von Xampp oder Laragon ist auf den ersten Blick komplex, muss aber nur 1x gemacht werden. Die Software läuft im normalen Internetbrowser und ist responsive. Sie kann also von allen Geräten im Netzwerk ohne weitere Voraussetzungen benutzt werden. Danke an zuramai für das Dashboard.

Das Userinferface ist in deutsch. (Aus historischen Gründen ist der Code auch in deutsch. Wird stetig umgebaut)

Features

• Mannschaften und Mannschaftswertung
• Altersklasse und Altersklassenwertung
• Vereine und Vereinswertung
• verschiedene Strecken können gleichzeitig erfasset werden
• Sonderwertungen (z.B. Nachtwertung, 13:00Uhr Wertung) individuell definierbar.
• anpassbare PDF-Urkunden, sowie Ergebnisliste, Meldelisten
• Lauf- und Schwimmveranstaltungen gleichermaßen verwaltbar
• Live-Anzeige von Buchungen
• Selbstauskunftsmöglichkeit für Teilnehmer
• Statistische Auswertung
• Alle Infos für die Presse und die Verantwortlichen auf einer Seite
• Verschiedenste Möglichkeiten die Buchungen zu erfassen
• Jede Buchung wird einzeln gespeichert. Schreiben automatische Rundenzähler (z.B. per RFID) direkt in die zugehörige DB-Tabelle, besteht Kompatibiltät zu jeder RFID-Anlage

Voraussetzungen

• Lokaler Webserver mit PHP > 8.0, Datenbank und Composer. Zum Beispiel: Laragon oder XAMPP. Bitte beachten. Beide Beispiele sind für lokales entwickeln gedacht. Sie sollen nicht ohne zusätzliche Konfiguration als Webserver im Internet genutzt werden. Gewisse Einstellungen müssen geändert werden, um den sicheren Einsatz zu ermöglichen.
• Laragon: https://laragon.org/
• Xampp: https://www.apachefriends.org/
• Composer: https://getcomposer.org/;
• GUI für Composer: https://getcomposercat.com/
• Git: https://git-scm.com/downloads (wird für Composer benötigt)

Installation

Vorhandener Server

1. Dateien kopieren nach CharitySwimRun/
2. Composer aufrufen und Abhängigkeiten installieren.
3. Weiter mit Abschnitt "Konfiguration"

Lokaler Webserver am Beispiel von Xampp

1. Xampp-Version mit PHP > 8.1 herunterladen und unter Windows möglichst nicht auf C:/ installieren
2. Dateien aus dem Repository herunterladen (Button: <> Code -> download Zip). Zip entpacken und in den Ordner xampp/htdocs/CharitySwimRun kopieren
3. Git, Composer und ComposerCat installieren, wenn nicht vorhanden. Git ist eine Voraussetzung für Composer. Composer wird für ComposerCat benötigt.
4. Mit Composer(Cat) in den Ordner xmapp/htdocs/CharitySwimRun/ navigieren und "composer upate" und im Anschluss "install all" ausführen
5. Die Datenbank mit Passwort sichern. Dazu PHPMyAdmin (127.0.0.1/phpmyadmin/) aufrufen und im Tab "User" einen neuen User mit Passwort und allen Rechten anlegen. Den vorhanden User mit dem Namen "root" im Anschluss löschen
6. Loginmodus ("auth type") der Datenbank in xmapp/phpmyadmin/config.inc.php von "cookie" auf "http" ändern
7. Über das XAMPP Control-Panel MariaDB/MySql neustarten

Lokaler Webserver am Beispiel von Laragon

1. Laragon nicht auf C:/ (Windowspartion) installieren
2. PHPMyAdmin hinzufügen (Quick Add -> PHPMyAdmin)
3. PHP > 8.1 hinzufügen, wenn notwendig (Anleitung, PHP Download)
4. MYSQL Einstellungen modifizieren über die Console in Laragon. Die drei Kommandos ausführen - mysql -u your_username -p - USE your_database; - SET GLOBAL sql_mode='';
5. (Nur für Entwickler: Einstellungen für XDebug: Anleitung für Laragon, Anleitung Visual Studio)
6. Die Datenbank mit Passwort sichern. Dazu PHPMyAdmin (127.0.0.1/phpmyadmin/) aufrufen und im Tab "User" einen neuen User mit Passwort und allen Rechten anlegen. Den vorhanden User mit dem Namen "root" im Anschluss löschen
7. MariaDB/MySql neustarten
8. Dateien aus dem Repository herunterladen (Button: <> Code -> download Zip). Zip entpacken und in den Ordner laragon/www/CharitySwimRun kopieren
9. Git, Composer und ComposerCat installieren, wenn nicht vorhanden. Git ist eine Voraussetzung für Composer. Composer wird für ComposerCat benötigt.
10. Mit Composer(Cat) in den Ordner htdocs/CharitySwimRun/ navigieren und "composer upate" und im Anschluss "install all" ausführen
11. ChartJs via Composer kommt nicht zusammengebaut. Daher manueller Download von jsdelivr erforderlich. Anschließend verschieben des /dist Ordner in den vendoer/nnnick/chartjs

Konfiguration

1. Software aufrufen: 127.0.0.1/CharitySwimRun/
2. Datenbankverbindungsdaten eingeben, wie im Schritt "Lokaler Webserver einrichten" angelegt. Datenbank und Tabellen werden automatisch erstellt. Werden die Daten nicht gespeichert, weil die Datei CharitySwimRun/config/dbConfigDaten.php nicht geschrieben wird, liegt das an der Installation auf C:/. Dann die Datei einfach manuell bearbeiten und die Daten manuell in die Felder eintragen.
3. Einstellungen setzen
4. Strecken anlegen
5. Altersklassen anlegen
6. (Nutzer anlegen)
7. "Simulator" ausprobieren.

Möglichkeiten Buchungen zu registrieren am Beispiel Schwimmveranstaltung

Am Beckenrand

Am Beckenrand sitzen menschliche Bahnenzähler. Diese haben ein Tablet, welches per lokalem Netzwerk dem Server verbunden ist. Über "Verwaltung" -> manuelle Eingaben (unterer Bereich) bauen Sie sich ein individuelles Set der Schwimmer auf ihrer Bahn und buchen die Bahnen per Klick.

Bei "Abmeldung" der Teilnehmer

Die Teilnehmer bekommen z.B. für jede Runde einen Gummiring. Die Gummieringe werden regelmäßig an einer zentralen Stelle abgegeben und über "Verwaltung" -> manuelle Eingaben (oberer Bereich) gebucht.

Mittels RFID Anlage

Eine RFID Anlage mit einer Software ist mit der der Datenbank verbunden und schreibt ihre Buchungen in die DB. Dazu bitte Kontakt mit dem Admin aufnehmen.