M1: Projektstruktur erstellt - Verzeichnisse und AGENTS.md

This commit is contained in:
2026-07-14 14:08:46 +02:00
commit 732156eb9d
2 changed files with 125 additions and 0 deletions
+115
View File
@@ -0,0 +1,115 @@
# goSportpunktetafel – Projektstatus
## Projekt-Info
- **Name:** goSportpunktetafel
- **Backend-Sprache:** Go
- **Git-Remote:** https://git.jlserver.de
- **Repository-URL:** https://git.jlserver.de/goSportpunktetafel.git (noch zu erstellen)
- **Go-Version:** 1.19.8
---
## Meilensteine
### ✅ M1: Projektstrukturierung und Planung
- [x] Projektverzeichnis erstellt
- [x] Alle notwendigen Verzeichnisse angelegt
- [x] AGENTS.md erstellt und wird fortlaufend aktualisiert
- [ ] Repository auf git.jlserver.de erstellt und initialer Push durchgeführt
- [ ] `go.mod` initialisiert
### ⏳ M2: Backend – USB-Tastatur-Handling
- [ ] Tastatureingaben im Hintergrund auslesen
- [ ] Diagnostik und Log-Ausgabe über stdout
- [ ] Systemd-Service-Beispieldatei
- [ ] Dokumentation
### ⏳ M3: Backend – Logik
- [ ] Zählerlogik implementiert
- [ ] Zustandsausgabe im Log
- [ ] Dokumentation
### ⏳ M4: Backend – Persistenz
- [ ] Speicherung des aktuellen Zählerstands in Datei (Flag)
- [ ] Laden des Zustands beim Start (falls vorhanden)
- [ ] Dokumentation
### ⏳ M5: Backend – mDNS
- [ ] HTTP-API über mDNS im Netzwerk bekannt machen
- [ ] Funktion zur Suche anderer Instanzen im Netzwerk
### ⏳ M6: Backend – HTTP-API-Schnittstelle
- [ ] Flags für Listening-Port und -Adresse (Default: Port 3000, alle IPv6/IPv4)
- [ ] `/api/...` – alle Steuer- und Statusfunktionen
- [ ] Alle API-Endpunkte vor Commit auf Funktion prüfen
- [ ] Dokumentation
### ⏳ M7: Frontend
- [ ] HTML, JS, CSS erstellt
- [ ] Plausibilitäts- und Funktionstest
- [ ] In Go-Binary integriert (embed)
- [ ] Unter `/` verfügbar
- [ ] End-to-End-Test
---
## Projektstruktur
```
goSportpunktetafel/
├── AGENTS.md
├── go.mod
├── cmd/
│ └── sportscore/
│ └── main.go
├── internal/
│ ├── config/ – Flag-Parsing, Konfiguration
│ ├── usb/ – USB-Tastatur-Handling
│ ├── logik/ – Zählerlogik (Rot/Grün, Runden)
│ ├── persistenz/ – Datei-basierte Persistenz
│ ├── mdns/ – mDNS-Bekanntmachung & Discovery
│ └── httpapi/ – HTTP-API-Server
├── static/ – Frontend (HTML, JS, CSS)
├── test/ – Testdateien
│ ├── usb/
│ ├── logik/
│ ├── persistenz/
│ ├── httpapi/
│ └── mdns/
├── systemd/ – Systemd-Service-Datei
├── docs/ – Dokumentation
└── scripts/ – Hilfs-Scripts
```
---
## Domänenlogik
### Teams
- **Rot** und **Grün**
### Tasten (USB-Tastatur)
| Taste | Aktion |
|-------|--------|
| `/` | +1 Punkt bei Team Rot |
| `*` | +1 Punkt bei Team Grün |
| `+` | Nächste Runde (0:0) |
| `-` | Alle Runden löschen, zurück zu Runde 1 (0:0) |
### Frontend-Anforderungen
- Dunkles Design
- Vollbild auf großem Bildschirm
- Zentral: Score (Rot : Grün)
- Unten: Highscores der vorherigen Runden (komma-getrennt)
- Menü oben links: Backend-Auswahl
- Lokal
- mDNS-Ergebnisse (aktualisierbar)
- Manuelle Server-Eingabe
- Ausgewähltes Backend wird in lokaler Persistenz gespeichert
---
## Aktueller Status
**Letztes Update:** 2026-07-14 14:07 CET
**Aktueller Meilenstein:** M1 – Projektstrukturierung und Planung
**Nächster Schritt:** Repository auf git.jlserver.de erstellen, `go.mod` initialisieren, ersten Push durchführen