feat: add realtime codenames game
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Codenames
|
||||
|
||||
Realtime-Codenames fuer Browser mit Java Spring Boot, nativen WebSockets und einem statischen HTML/JS-Frontend.
|
||||
|
||||
## Funktionen
|
||||
|
||||
- Raum erstellen und mit kurzer ID teilen
|
||||
- Spieler und Zuschauer koennen demselben Raum beitreten
|
||||
- Vier Rollen: Rot/Blau jeweils Hinweisgeber und Ermittler
|
||||
- Vollstaendiger Rundenablauf mit Hinweis, Ratephase, Zugende und Siegbedingung
|
||||
- Personalisierte Board-Sicht: nur Hinweisgeber sehen verdeckte Teamzuordnungen
|
||||
- Kubernetes-Deployment unter `deploy/k8s`
|
||||
|
||||
## Lokal starten
|
||||
|
||||
```bash
|
||||
./gradlew bootRun
|
||||
```
|
||||
|
||||
Danach ist die App unter [http://localhost:8080](http://localhost:8080) erreichbar.
|
||||
|
||||
## Tests und Build
|
||||
|
||||
```bash
|
||||
./gradlew test bootJar
|
||||
docker build -t git.dslan.at/zeugs/codenames:master .
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
Die Kubernetes-Manifeste liegen unter [deploy/k8s](/Users/dschramm/git.dslan.at/codenames/deploy/k8s) und werden in `argo-cd-apps` als eigene ArgoCD-Application eingebunden.
|
||||
|
||||
## Wortbasis
|
||||
|
||||
Die deutsche Begriffsliste wurde fuer dieses Projekt aus einer im Web frei herunterladbaren deutschen Nomenliste kuratiert, insbesondere auf Basis der Sketch-Engine-Wortlisten:
|
||||
|
||||
- [Sketch Engine Word Lists](https://www.sketchengine.eu/word-lists/)
|
||||
- [German noun frequency list (PDF)](https://www.sketchengine.eu/wp-content/uploads/word-list/german/german-word-list-nouns.pdf)
|
||||
Reference in New Issue
Block a user