commit e5c9279b3c16fa3def204ae130272f5e1b6d477c Author: Thies Mueller Date: Mon Jun 22 18:07:41 2026 +0200 initial commit diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..41dbbaa Binary files /dev/null and b/.DS_Store differ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ac049ce --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +public +site +.swp +.trunk +.venv +*/.DS_Store +.DS_Store \ No newline at end of file diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000..a700d40 Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/API/02_public.md b/docs/API/02_public.md new file mode 100644 index 0000000..267bdd8 --- /dev/null +++ b/docs/API/02_public.md @@ -0,0 +1,105 @@ +--- +hide: + - footer +--- +# Public API + +Folgende API Endpunkte stellen wir zur Verfügung: + +## Allgemeine Erklärungen + +- Die öffentliche API befindet sich meistens unter `https://api..regattatech.de`, kann aber je nach Wunsch auch unter einer anderen Domain publiziert werden. + +- "öffentliche API" meint in dem Zusammenhang, dass kein API Key benötigt wird. Es können jedoch IP Beschränkungen oder andere Sicherheitsvorkehrungen für bestimmte Endpunkte definiert sein. + +- Die Endpunkte enden meistens mit einem `/current/` dies spezifiziert die aktuellste Regatta. Sollte eine andere Regatta gewünscht werden, kann diese mit der laufenden Regatta ID anstelle von `/current/` gewählt werden (zB `/2/`) + +### /api/v1/bootliste/current/ + +#### Aufbau +Gibt in einem strukturierten JSON folgende Informationen aus: + +- Eindeutige Boot-ID +- Name des Bootes +- Ggf. ehemalige Namen des Bootes +- Ob das betreffende Boot ein Jugendboot ist +- *Wer an der Trommel sitzt* +- *Wer "Auf Schlag" sitzt* +- *Woher das Team kommt* +- *Wie sich das Team definiert* +- *Bisherige Platzierungen* +- *Ob dies die erste Teilnahme ist* +- *Wie häufig schon teilgenommen wurde* +- *Ziele bei der Regatta* +- *Was das Team auszeichnet* +- *Schlachtruf des Teams* +- *Notizen zum Team* +- *Status des Teams (Veröffentlicht J/N)* +- *Pager ID des Teams* +- *Link zum Teambild* + +Die Infos in Kursiv werden ggf. nur bestimmten Endpunkten mitgeteilt und sind hauptsächlich für Internetpräsenzen und Moderation gedacht. + +#### Verwendung + +- Apps +- Moderation +- Webseiten + +### /api/v1/message + +#### Aufbau +Gibt in einem strukturierten JSON folgende Informationen aus: + +- Nachricht +- Wichtigkeit der Nachricht + +#### Verwendung + +- Apps +- Webseiten +- Moderation +- Push + +### /api/v1/rennplan/current/ + +#### Aufbau +Gibt in einem strukturierten JSON folgende Informationen aus: + +- Rennplan nach Lauf und Rennen +- UUID des jeweiligen Rennens +- Teilnehmende Boote nach Bahn des jeweiligen Rennens +- Zeitpunkt des jeweiligen Rennens +- Name des jeweiligen Rennens +- Laufende Nummer des jeweiligen Rennens +- Art des jeweiligen Rennens + +#### Verwendung + +- Apps +- Webseiten +- Moderation + +### /api/v1/results/current/ + +#### Aufbau +Gibt in einem strukturierten JSON folgende Informationen aus: + +- Ergebnisse nach Rennen +- UUID des jeweiligen Rennens +- Teilnehmende Boote nach Bahn des jeweiligen Rennens +- Gefahrene Zeit des Bootes nach Bahn & Rennen +- Zeitpunkt des jeweiligen Rennens +- Name des jeweiligen Rennens +- Laufende Nummer des jeweiligen Rennens +- Art des jeweiligen Rennens + +#### Verwendung + +- Apps +- Webseiten +- Moderation + +#### Besonderheiten + +**In bestimmten Modi werden während des letzten Laufes keine Ergebnisse über diese API publiziert!** \ No newline at end of file diff --git a/docs/API/03_private.md b/docs/API/03_private.md new file mode 100644 index 0000000..8d46783 --- /dev/null +++ b/docs/API/03_private.md @@ -0,0 +1,7 @@ +--- +hide: + - footer +--- +# Private API + +**Da die private API kundenspezifisch entwickelt und betrieben wird, gibt es keine öffentliche Dokumentation dieser API** \ No newline at end of file diff --git a/docs/API/index.md b/docs/API/index.md new file mode 100644 index 0000000..486fe09 --- /dev/null +++ b/docs/API/index.md @@ -0,0 +1,21 @@ +--- +hide: + - footer +--- +# API + +Die Core Applikation publiziert verschiedenste Daten über eine API. + +Die API ist in 2 Bereiche unterteilt. + +- Eine öffentliche Read-Only API welche Ergebnisse & Informationen Rund um die Regatta publiziert. Diese nutzen wir an verschiedensten Stellen, zB: + - WebApp + - Apps + - Bots + +- Eine private Read-Write API die mit dem Core System kommuniziert. Diese nutzen wir nur, wenn ein Schreibzugriff benötigt wird, zB: + - Ergebnisse automatisiert eintragen + - Pager auslösen + - Boote anlegen/editieren + +Die öffentliche API wird hier dokumentiert. Die Dokumentation der privaten API steht für unsere Kund*\innen oder auf Anfrage zur Verfügung. diff --git a/docs/Apps/02_android.md b/docs/Apps/02_android.md new file mode 100644 index 0000000..9ebf5d6 --- /dev/null +++ b/docs/Apps/02_android.md @@ -0,0 +1,12 @@ +--- +hide: + - footer +--- +# Android App + +Unsere Android App ist in flutter entwickelt. +Sie unterstützt folgende Features: + +- Ergebnisse +- Rennpläne +- Push Benachrichtigungen (firebase) \ No newline at end of file diff --git a/docs/Apps/02_ios.md b/docs/Apps/02_ios.md new file mode 100644 index 0000000..a6bfc96 --- /dev/null +++ b/docs/Apps/02_ios.md @@ -0,0 +1,12 @@ +--- +hide: + - footer +--- +# iOS App + +Unsere iOS App ist nativ in Swift entwickelt. +Sie unterstützt folgende Features: + +- Ergebnisse +- Rennpläne +- Push Benachrichtigungen (apns2) \ No newline at end of file diff --git a/docs/Apps/03_web.md b/docs/Apps/03_web.md new file mode 100644 index 0000000..b44ef6d --- /dev/null +++ b/docs/Apps/03_web.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Web App + +Unsere Web App ist in HTML & JS entwickelt. +Sie unterstützt folgende Features: + +- Ergebnisse +- Rennpläne \ No newline at end of file diff --git a/docs/Apps/index.md b/docs/Apps/index.md new file mode 100644 index 0000000..2bf413e --- /dev/null +++ b/docs/Apps/index.md @@ -0,0 +1,13 @@ +--- +hide: + - footer +--- +# Apps + +Für die Ergebnispräsentation und Rennpläne haben wir Apps entwickelt, welche die Daten darstellen. Diese sind Push fähig und beziehen ihre Daten direkt von der API des Core Systems. + +Aktuell können wir Apps für folgende Plattformen bereitstellen: + +- Android (Google Play Store) +- iOS / iPadOS / macOS (Apple AppStore) +- Web \ No newline at end of file diff --git a/docs/Core/02_regatta.md b/docs/Core/02_regatta.md new file mode 100644 index 0000000..a00c5ea --- /dev/null +++ b/docs/Core/02_regatta.md @@ -0,0 +1,22 @@ +--- +hide: + - footer +--- +# Regatta Anlegen + +Klicke als erstes auf Regatta anlegen + +![Regatta Anlegen](/assets/images/core/02_regatta/s01.png) + +Es öffnet sich eine Eingabemaske. + +Fülle mindestens alle Felder aus, die mit einem Roten Pfeil markiert sind. + +![s02](/assets/images/core/02_regatta/s02.png) + +![s03](/assets/images/core/02_regatta/s03.png) + +Die Regatta ist angelegt und wird automatisch geladen. Dort können nun Boote hinzugefügt werden, oder die Regatta editiert werden. + + +![s04](/assets/images/core/02_regatta/s04.png) \ No newline at end of file diff --git a/docs/Core/03_boote_anlegen.md b/docs/Core/03_boote_anlegen.md new file mode 100644 index 0000000..bc75b63 --- /dev/null +++ b/docs/Core/03_boote_anlegen.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Boote Anlegen + +**Boote Anlegen funktioniert aktuell nur über die Admin Ansicht!** + +Boote können aktuell nur über unsere Shop-Integration oder manuell angelegt werden. + +Wir sind aber bereits dabei das zu ändern! \ No newline at end of file diff --git a/docs/Core/04_boote_zuweisen.md b/docs/Core/04_boote_zuweisen.md new file mode 100644 index 0000000..c7fdd7f --- /dev/null +++ b/docs/Core/04_boote_zuweisen.md @@ -0,0 +1,17 @@ +--- +hide: + - footer +--- +# Boote Zuweisen + +In der Regatta Ansicht, scrolle nach unten und wähle "Boote zuweisen" aus. + +![s01](/assets/images/core/04_boote_zuweisen/s01.png) + +Wähle dann alle Boote aus die zugewiesen werden sollen. +Oben erscheint ein Counter wie viele Boote zugewiesen sind und wie viele maximal zugewiesen werden können. +![s02](/assets/images/core/04_boote_zuweisen/s02.png) +Dieser Counter ändert updated sich live, damit du immer den Überblick hast wie viele Boote du noch zuweisen kannst. +![s03](/assets/images/core/04_boote_zuweisen/s03.png) +Klicke am Ende auf "Boote zuweisen" um die Boote der Regatta zuzuweisen +![s04](/assets/images/core/04_boote_zuweisen/s04.png) diff --git a/docs/Core/05_boote_sortieren.md b/docs/Core/05_boote_sortieren.md new file mode 100644 index 0000000..341cf50 --- /dev/null +++ b/docs/Core/05_boote_sortieren.md @@ -0,0 +1,31 @@ +--- +hide: + - footer +--- +# Lauf 1 Erstellen / Boote in Rennen sortieren + +Um den Lauf 1 zu erstellen drücke in der Regatta **nach dem ausreichend Boote zugewiesen sind** auf "Lauf auffüllen" + +![s01](/assets/images/core/05_boote_sortieren/s01.png) + +Dadurch wird der Lauf zufällig mit den zugewiesenen Booten gefüllt. + +### Boote manuell verschieben + +Um die Boote nach dem erstellen des Lauf 1 manuell zu sortieren, klicke auf den Lauf. + +![s02](/assets/images/core/05_boote_sortieren/s02.png) + +Scrolle nach unten und klicke auf "Boote neu auf Bahnen sortieren" + +![s03](/assets/images/core/05_boote_sortieren/s03.png) + +Nun kannst du per Drag & Drop die Boote neu in Rennen & Bahnen sortieren. + +![s04](/assets/images/core/05_boote_sortieren/s04.png) + +Scrolle am Ende nach unten und klicke auf "Speichern" + +Solltest du Boote entfernt haben und nicht mehr alle Läufe vollständig sein, klicke auf "Trotzdem Speichern" + +![s05](/assets/images/core/05_boote_sortieren/s05.png) diff --git a/docs/Core/06_rennplan_drucken.md b/docs/Core/06_rennplan_drucken.md new file mode 100644 index 0000000..8633265 --- /dev/null +++ b/docs/Core/06_rennplan_drucken.md @@ -0,0 +1,13 @@ +--- +hide: + - footer +--- +# Rennplan ausdrucken / als PDF exportieren + +Um den Rennplan auszudrucken oder als PDF zu exportieren drücke auf den "Drucker"-Button neben dem Lauf + +![s01](/assets/images/core/06_rennplan_drucken/s01.png) + +Dann öffnet sich automatisch der Rennplan im praktischen PDF Format und kann entweder gedruckt oder gespeichert werden + +![s02](/assets/images/core/06_rennplan_drucken/s02.png) diff --git a/docs/Core/07_zeiten_erfassen.md b/docs/Core/07_zeiten_erfassen.md new file mode 100644 index 0000000..6daa474 --- /dev/null +++ b/docs/Core/07_zeiten_erfassen.md @@ -0,0 +1,19 @@ +--- +hide: + - footer +--- +# Zeiten erfassen + +Um Zeiten zu erfassen klicke auf den aktuellen Lauf + +![s01](/assets/images/core/07_zeiten_erfassen/s01.png) + +Klicke dann auf das Rennen für das du die Zeiten erfassen möchtest + +![s02](/assets/images/core/07_zeiten_erfassen/s02.png) + +Trage die Zeiten ein und klicke anschließend auf "Ergebnis speichern" +![s03](/assets/images/core/07_zeiten_erfassen/s03.png) + +Zur Bestätigung wird das Ergebnis angezeigt. Gleichzeitig wird (wenn verfügbar) die Benachrichtigung via Push Benachrichtigung an Apps & Schnittstellen übertragen. +![s04](/assets/images/core/07_zeiten_erfassen/s04.png) \ No newline at end of file diff --git a/docs/Core/index.md b/docs/Core/index.md new file mode 100644 index 0000000..98b8788 --- /dev/null +++ b/docs/Core/index.md @@ -0,0 +1,7 @@ +--- +hide: + - footer +--- +# Core Applikation + +Die Core Applikation ist modular aufgebaut und enthält verschiedene Bereiche. diff --git a/docs/Schnittstellen/Ergebnis Monitore/index.md b/docs/Schnittstellen/Ergebnis Monitore/index.md new file mode 100644 index 0000000..be9723d --- /dev/null +++ b/docs/Schnittstellen/Ergebnis Monitore/index.md @@ -0,0 +1,9 @@ +--- +hide: + - footer +--- +# Ergebnis Monitore + +Wir bieten an, auf Wunsch ein System zu betreiben, welches mit Informationen aus der öffentlichen API informatioen abruft und auf großen Bildschirmen (zB Fernsehern/Beamern/LED Wänden) diese Informationen anzeigt. + +Dieses System ist darauf optimiert keine Nutzereingaben zu erfordern (scrollt zB automatisiert durch die Ergebnisse) \ No newline at end of file diff --git a/docs/Schnittstellen/Moderation/index.md b/docs/Schnittstellen/Moderation/index.md new file mode 100644 index 0000000..14ed98f --- /dev/null +++ b/docs/Schnittstellen/Moderation/index.md @@ -0,0 +1,9 @@ +--- +hide: + - footer +--- +# Moderationstools + +Wir bieten unterschiedliche Moderationstools an. + +Diese liefern Informationen zur aktuellen Regatta, die Möglichkeit Teams über die Pager Systeme zu informieren, sowie die Möglichkeit weitere Informationen für die Moderator*\innen zur Verfügung zu stellen um eine möglichst flüssige Moderation zu liefern. \ No newline at end of file diff --git a/docs/Schnittstellen/Pager/02_pager.md b/docs/Schnittstellen/Pager/02_pager.md new file mode 100644 index 0000000..c6d7803 --- /dev/null +++ b/docs/Schnittstellen/Pager/02_pager.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Pager benutzen + +Aktuell unterstützen wir Pager nur bei einer Full Service Regatta, das heißt wenn wir vor Ort sind und das System betreuen. + +Grund dafür ist, dass die Pager Relays und sende Stationen vor Ort aufgebaut werden müssen und Konfiguration benötigen. + +Solltet ihr ein eigenes Pager System besitzen, welches eine API Integration bietet, können wir bei Bedarf dieses System implementieren. diff --git a/docs/Schnittstellen/Pager/index.md b/docs/Schnittstellen/Pager/index.md new file mode 100644 index 0000000..c24447b --- /dev/null +++ b/docs/Schnittstellen/Pager/index.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Pager + +Unser Pagersystem bindet sich in unsere Core Applikation ein. + +Es können auf einer Regatta an Teams Pager ausgegeben werden, welche zu definierbaren Zeitpunkten vibrieren und ein akustisches Signal von sich geben. + +Die Pager arbeiten auf dem 433.92MHz Band und werden von einem lokalen System, mit mehreren Relays gesteuert. diff --git a/docs/Schnittstellen/Push/02_telegram.md b/docs/Schnittstellen/Push/02_telegram.md new file mode 100644 index 0000000..8fb0523 --- /dev/null +++ b/docs/Schnittstellen/Push/02_telegram.md @@ -0,0 +1,19 @@ +--- +hide: + - footer +--- +# Telegram Bot + +Wir bieten an, einen Telegram Bot zu betreiben. +Dieser bietet neben Push Benachrichtigungen auch die Möglichkeit Interaktiv den Rennplan abzurufen. + + +Regatta Ergebnisse als Push Benachrichtigung: +![s01](/assets/images/schnittstellen/push/telegram/s01.png) + +Interaktiver Bot für Rennpläne: +![s02](/assets/images/schnittstellen/push/telegram/s02.png) + +![s03](/assets/images/schnittstellen/push/telegram/s03.png) + +![s04](/assets/images/schnittstellen/push/telegram/s04.png) \ No newline at end of file diff --git a/docs/Schnittstellen/Push/index.md b/docs/Schnittstellen/Push/index.md new file mode 100644 index 0000000..f217e30 --- /dev/null +++ b/docs/Schnittstellen/Push/index.md @@ -0,0 +1,16 @@ +--- +hide: + - footer +--- +# Push + +Das Core System kann (wenn konfiguriert) zu definierbaren Zeitpunkten Push Benachrichtigungen verschicken. +Dafür versendet das System an unsere Push Schnittstelle die Benachrichtigung. + +Diese sendet dann die Benachrichtigung an die verschiedenen Kanäle. + +Folgende Kanäle werden aktuell unterstützt: + +- Apple iOS / iPadOS / macOS +- Android +- Telegram \ No newline at end of file diff --git a/docs/Schnittstellen/Wordpress/02_teams.md b/docs/Schnittstellen/Wordpress/02_teams.md new file mode 100644 index 0000000..b74d500 --- /dev/null +++ b/docs/Schnittstellen/Wordpress/02_teams.md @@ -0,0 +1,9 @@ +--- +hide: + - footer +--- +# Team Präsentation + +Über unser Team Sync Plugin, bieten wir die Möglichkeit auf einer WordPress Seite Informationen zu den Teams anzuzeigen. + +Das Plugin erhälst du bei unserem Support. \ No newline at end of file diff --git a/docs/Schnittstellen/Wordpress/03_rennplan.md b/docs/Schnittstellen/Wordpress/03_rennplan.md new file mode 100644 index 0000000..489829d --- /dev/null +++ b/docs/Schnittstellen/Wordpress/03_rennplan.md @@ -0,0 +1,9 @@ +--- +hide: + - footer +--- +# Rennpläne + +Über unser Rennplan Sync Plugin, bieten wir die Möglichkeit auf einer WordPress Seite die aktuellen Rennpläne einer Regatta anzuzeigen. + +Das Plugin erhälst du bei unserem Support. \ No newline at end of file diff --git a/docs/Schnittstellen/Wordpress/index.md b/docs/Schnittstellen/Wordpress/index.md new file mode 100644 index 0000000..18b36cb --- /dev/null +++ b/docs/Schnittstellen/Wordpress/index.md @@ -0,0 +1,8 @@ +--- +hide: + - footer +--- +# Wordpress + +Wir bieten mehrere Schnittstellen für das CMS "WordPress" an. +Diese bedienen sich an der Public API und bieten so eine interaktive Möglichkeit die Webseite auszugestalten. \ No newline at end of file diff --git a/docs/Schnittstellen/index.md b/docs/Schnittstellen/index.md new file mode 100644 index 0000000..711ed89 --- /dev/null +++ b/docs/Schnittstellen/index.md @@ -0,0 +1,7 @@ +--- +hide: + - footer +--- +# Schnittstellen + +Wir betreiben verschiedene Schnittstellen, welche auf Wunsch & nach Bedarf zur Verfügung gestellt werden können. \ No newline at end of file diff --git a/docs/Weiteres/02_vorverkauf.md b/docs/Weiteres/02_vorverkauf.md new file mode 100644 index 0000000..f3b5eee --- /dev/null +++ b/docs/Weiteres/02_vorverkauf.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Vorverkauf + +Wir bieten an den Vorverkauf eurer Regatta zu organisieren. + +Dies umfasst die Konfiguration & den Betrieb eines Shop Systems (auf Wunsch mit eigener Domain) welches von Vorverkauf, über bestimmte Abfragen, bis hin zur Zahlungsabwicklung und Rechnungserstellung alles übernehmen kann. + +Wir setzen dafür auf die Software "pretix" \ No newline at end of file diff --git a/docs/Weiteres/03_rennleitung.md b/docs/Weiteres/03_rennleitung.md new file mode 100644 index 0000000..1b8aacd --- /dev/null +++ b/docs/Weiteres/03_rennleitung.md @@ -0,0 +1,8 @@ +--- +hide: + - footer +--- +# Rennleitung + +Natürlich kommen wir gerne vorbei und betreuen die Regatta vor Ort. +Mit unserer jahrelanger Erfahrung bieten wir die Möglichkeit den Ablauf der Regatta an uns und unsere Partner auszulagern. \ No newline at end of file diff --git a/docs/Weiteres/04_internet.md b/docs/Weiteres/04_internet.md new file mode 100644 index 0000000..6e760d9 --- /dev/null +++ b/docs/Weiteres/04_internet.md @@ -0,0 +1,13 @@ +--- +hide: + - footer +--- +# Internet Vor-Ort + +Wir wissen. So ein tolles Setup bringt nichts, wenn dann kein Internet vor Ort zur Verfügung steht. + +Daher bieten wir an die Zeiterfassung / Rennleitung direkt mit ins Internet zu bringen. + +Egal ob DSL, LTE, 5G oder Sattelitenverbindung, wir bringen das System online. + +*DSL Verbindung muss vom Veranstalter gestellt werden, andere Systeme können bei uns geliehen werden* \ No newline at end of file diff --git a/docs/Weiteres/05_multimedia.md b/docs/Weiteres/05_multimedia.md new file mode 100644 index 0000000..f0b1fad --- /dev/null +++ b/docs/Weiteres/05_multimedia.md @@ -0,0 +1,26 @@ +--- +hide: + - footer +--- +# Photos & Videos + +**Auf Wunsch dokumentieren wir die Regatta für euch.** + +Mit Drohnen, Videokameras & Photokameras sind wir für euch vor Ort und filmen & photografieren die Regatta und den Trubel drum herum. + +Gerne schneiden wir die Videos danach zu einem kurzen Video zusammen, oder bearbeiten die Photos im Nachgang. + +Sprecht uns einfach an! + + +#### Beispiel Videos: + +- [Sport am Tankumsee 2024](https://www.youtube.com/watch?v=5WF_HB0ztoc) +- [Sport am Tankumsee 2026](https://www.youtube.com/watch?v=OQKauq4nus8) + +## Photobox + +Auf Wunsch stellen wir vor Ort eine Photobox auf. +An dieser können eure Besucher*\innen Photos machen, diese per QR-Code abrufen oder sich (auf Wunsch) direkt ausdrucken lassen. + +Sprecht uns auch dafür gerne an! \ No newline at end of file diff --git a/docs/Weiteres/06_websites.md b/docs/Weiteres/06_websites.md new file mode 100644 index 0000000..2f4e967 --- /dev/null +++ b/docs/Weiteres/06_websites.md @@ -0,0 +1,11 @@ +--- +hide: + - footer +--- +# Webseiten + +Noch keine eigene Webseite? + +Oder schon, aber seit jahren nichts mehr dran gemacht? + +Wir bieten euch an, zusammen mit unseren Partnerfirmen die Webseite zu überarbeiten und direkt unsere Systeme zu integrieren. \ No newline at end of file diff --git a/docs/Weiteres/index.md b/docs/Weiteres/index.md new file mode 100644 index 0000000..c7e223a --- /dev/null +++ b/docs/Weiteres/index.md @@ -0,0 +1,9 @@ +--- +hide: + - footer +--- +# Weitere Services + +Auf Wunsch bieten wir weitere Services an. Diese sind hier dokumentiert. + +Die spezifische Dokumentation für einzelne Services befindet sich ggf. an einem anderen Ort. \ No newline at end of file diff --git a/docs/assets/.DS_Store b/docs/assets/.DS_Store new file mode 100644 index 0000000..10f526f Binary files /dev/null and b/docs/assets/.DS_Store differ diff --git a/docs/assets/css/img.css b/docs/assets/css/img.css new file mode 100644 index 0000000..be62543 --- /dev/null +++ b/docs/assets/css/img.css @@ -0,0 +1,30 @@ +/* Scale to fit the page */ +/* Small images will become very blurry */ +/* Not recommended */ + +.md-content__inner img { + width: 100%; +} + +/* Scale to fit the page with constraints */ +/* Smaller images will be min 25% of the width, so not as blurry */ +/* Bigger images will be max 90% of the width, better for centring (?) */ + + +.md-content__inner img { + min-width: 25%; + max-width: 90%; +} + +/* Center the images */ + +.md-content__inner img { + display: block; + margin: 0 auto; +} + +/* Add outline to make them pop */ + +.md-content__inner img { + outline: 1px solid var(--md-accent-fg-color); +} diff --git a/docs/assets/images/.DS_Store b/docs/assets/images/.DS_Store new file mode 100644 index 0000000..14891d4 Binary files /dev/null and b/docs/assets/images/.DS_Store differ diff --git a/docs/assets/images/core/.DS_Store b/docs/assets/images/core/.DS_Store new file mode 100644 index 0000000..844771e Binary files /dev/null and b/docs/assets/images/core/.DS_Store differ diff --git a/docs/assets/images/core/02_regatta/s01.png b/docs/assets/images/core/02_regatta/s01.png new file mode 100644 index 0000000..419bf7a Binary files /dev/null and b/docs/assets/images/core/02_regatta/s01.png differ diff --git a/docs/assets/images/core/02_regatta/s02.png b/docs/assets/images/core/02_regatta/s02.png new file mode 100644 index 0000000..2c9261c Binary files /dev/null and b/docs/assets/images/core/02_regatta/s02.png differ diff --git a/docs/assets/images/core/02_regatta/s03.png b/docs/assets/images/core/02_regatta/s03.png new file mode 100644 index 0000000..bfce207 Binary files /dev/null and b/docs/assets/images/core/02_regatta/s03.png differ diff --git a/docs/assets/images/core/02_regatta/s04.png b/docs/assets/images/core/02_regatta/s04.png new file mode 100644 index 0000000..647b505 Binary files /dev/null and b/docs/assets/images/core/02_regatta/s04.png differ diff --git a/docs/assets/images/core/04_boote_zuweisen/s01.png b/docs/assets/images/core/04_boote_zuweisen/s01.png new file mode 100644 index 0000000..8c799f0 Binary files /dev/null and b/docs/assets/images/core/04_boote_zuweisen/s01.png differ diff --git a/docs/assets/images/core/04_boote_zuweisen/s02.png b/docs/assets/images/core/04_boote_zuweisen/s02.png new file mode 100644 index 0000000..ef55283 Binary files /dev/null and b/docs/assets/images/core/04_boote_zuweisen/s02.png differ diff --git a/docs/assets/images/core/04_boote_zuweisen/s03.png b/docs/assets/images/core/04_boote_zuweisen/s03.png new file mode 100644 index 0000000..b2f6e32 Binary files /dev/null and b/docs/assets/images/core/04_boote_zuweisen/s03.png differ diff --git a/docs/assets/images/core/04_boote_zuweisen/s04.png b/docs/assets/images/core/04_boote_zuweisen/s04.png new file mode 100644 index 0000000..075da97 Binary files /dev/null and b/docs/assets/images/core/04_boote_zuweisen/s04.png differ diff --git a/docs/assets/images/core/05_boote_sortieren/s01.png b/docs/assets/images/core/05_boote_sortieren/s01.png new file mode 100644 index 0000000..1ecb5a1 Binary files /dev/null and b/docs/assets/images/core/05_boote_sortieren/s01.png differ diff --git a/docs/assets/images/core/05_boote_sortieren/s02.png b/docs/assets/images/core/05_boote_sortieren/s02.png new file mode 100644 index 0000000..02a92c0 Binary files /dev/null and b/docs/assets/images/core/05_boote_sortieren/s02.png differ diff --git a/docs/assets/images/core/05_boote_sortieren/s03.png b/docs/assets/images/core/05_boote_sortieren/s03.png new file mode 100644 index 0000000..c438651 Binary files /dev/null and b/docs/assets/images/core/05_boote_sortieren/s03.png differ diff --git a/docs/assets/images/core/05_boote_sortieren/s04.png b/docs/assets/images/core/05_boote_sortieren/s04.png new file mode 100644 index 0000000..a2e9a14 Binary files /dev/null and b/docs/assets/images/core/05_boote_sortieren/s04.png differ diff --git a/docs/assets/images/core/05_boote_sortieren/s05.png b/docs/assets/images/core/05_boote_sortieren/s05.png new file mode 100644 index 0000000..809e426 Binary files /dev/null and b/docs/assets/images/core/05_boote_sortieren/s05.png differ diff --git a/docs/assets/images/core/06_rennplan_drucken/s01.png b/docs/assets/images/core/06_rennplan_drucken/s01.png new file mode 100644 index 0000000..0115f4b Binary files /dev/null and b/docs/assets/images/core/06_rennplan_drucken/s01.png differ diff --git a/docs/assets/images/core/06_rennplan_drucken/s02.png b/docs/assets/images/core/06_rennplan_drucken/s02.png new file mode 100644 index 0000000..efbb8ee Binary files /dev/null and b/docs/assets/images/core/06_rennplan_drucken/s02.png differ diff --git a/docs/assets/images/core/07_zeiten_erfassen/s01.png b/docs/assets/images/core/07_zeiten_erfassen/s01.png new file mode 100644 index 0000000..02a92c0 Binary files /dev/null and b/docs/assets/images/core/07_zeiten_erfassen/s01.png differ diff --git a/docs/assets/images/core/07_zeiten_erfassen/s02.png b/docs/assets/images/core/07_zeiten_erfassen/s02.png new file mode 100644 index 0000000..531e432 Binary files /dev/null and b/docs/assets/images/core/07_zeiten_erfassen/s02.png differ diff --git a/docs/assets/images/core/07_zeiten_erfassen/s03.png b/docs/assets/images/core/07_zeiten_erfassen/s03.png new file mode 100644 index 0000000..a85c723 Binary files /dev/null and b/docs/assets/images/core/07_zeiten_erfassen/s03.png differ diff --git a/docs/assets/images/core/07_zeiten_erfassen/s04.png b/docs/assets/images/core/07_zeiten_erfassen/s04.png new file mode 100644 index 0000000..259045e Binary files /dev/null and b/docs/assets/images/core/07_zeiten_erfassen/s04.png differ diff --git a/docs/assets/images/regattatech-logo.png b/docs/assets/images/regattatech-logo.png new file mode 100644 index 0000000..2171830 Binary files /dev/null and b/docs/assets/images/regattatech-logo.png differ diff --git a/docs/assets/images/schnittstellen/.DS_Store b/docs/assets/images/schnittstellen/.DS_Store new file mode 100644 index 0000000..e3934ab Binary files /dev/null and b/docs/assets/images/schnittstellen/.DS_Store differ diff --git a/docs/assets/images/schnittstellen/push/.DS_Store b/docs/assets/images/schnittstellen/push/.DS_Store new file mode 100644 index 0000000..c7f5dad Binary files /dev/null and b/docs/assets/images/schnittstellen/push/.DS_Store differ diff --git a/docs/assets/images/schnittstellen/push/telegram/s01.png b/docs/assets/images/schnittstellen/push/telegram/s01.png new file mode 100644 index 0000000..d1814a4 Binary files /dev/null and b/docs/assets/images/schnittstellen/push/telegram/s01.png differ diff --git a/docs/assets/images/schnittstellen/push/telegram/s02.png b/docs/assets/images/schnittstellen/push/telegram/s02.png new file mode 100644 index 0000000..bc4b8ad Binary files /dev/null and b/docs/assets/images/schnittstellen/push/telegram/s02.png differ diff --git a/docs/assets/images/schnittstellen/push/telegram/s03.png b/docs/assets/images/schnittstellen/push/telegram/s03.png new file mode 100644 index 0000000..05c01ac Binary files /dev/null and b/docs/assets/images/schnittstellen/push/telegram/s03.png differ diff --git a/docs/assets/images/schnittstellen/push/telegram/s04.png b/docs/assets/images/schnittstellen/push/telegram/s04.png new file mode 100644 index 0000000..d2b9f8d Binary files /dev/null and b/docs/assets/images/schnittstellen/push/telegram/s04.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d495c1d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +--- +hide: + - footer +--- +# RegattaTech.DE Doku + +![logo](/assets/images/regattatech-logo.png) + +**Willkommen auf der Doku Seite von RegattaTech.DE** + +Hier findest du Dokumentation zu unseren Systemen. + +Sollten irgendwelche Fragen nicht beantwortet werden, wende dich gerne an unser Support Team unter [hi@regattatech.de](mailto:hi@regattatech.de){ .md-button } + +


+ +
+ +

+[Legal](https://legal.tservic.es){ .md-button } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..98b3f1a --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: RegattaTech.DE Dokumentation +site_url: https://doku.regattatech.de + + +theme: + language: de + name: material + font: false + features: + - navigation.sections + - navigation.indexes + - toc.integrate + - navigation.footer + logo: assets/images/regattatech-logo.png + +extra_css: + - assets/css/img.css + +plugins: + - search + - awesome-pages + +markdown_extensions: + - abbr + - pymdownx.snippets + - admonition + - pymdownx.details + - pymdownx.superfences + - attr_list + - md_in_html + - pymdownx.tabbed + - footnotes + + + +repo_name: rg/doku +repo_url: https://git.tservic.es/rg/doku + + + +extra: + generator: true + social: + - icon: fontawesome/brands/git + link: https://git.tservic.es/rg + name: callme + - icon: fontawesome/solid/paper-plane + link: mailto:hi@regattatech.de + name: mailme + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c7571bc --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +mkdocs==1.6.1 +mkdocs-awesome-pages-plugin==2.9.3 +mkdocs-get-deps==0.2.0 +mkdocs-material==9.5.35 +mkdocs-material-extensions==1.3.1 +jinja2 +mkdocs-bootswatch +