Files
segnapunti/README.md
T

216 lines
5.8 KiB
Markdown
Raw Permalink Normal View History

2026-05-12 14:54:36 +02:00
# Segnapunti
![Version](https://img.shields.io/badge/versione-2.0.0-blue)
![Node](https://img.shields.io/badge/node-%3E%3D18-green)
![Docker](https://img.shields.io/badge/docker-ready-2496ED?logo=docker&logoColor=white)
![License](https://img.shields.io/badge/licenza-privata-lightgrey)
Segnapunti digitale in tempo reale per partite di pallavolo. Un server centrale gestisce lo stato della partita; un **display** mostra il tabellone pubblico e un **controller** (smartphone o tablet) permette all'operatore di gestire punti, formazioni e cambi.
2026-01-28 13:31:42 +01:00
---
2026-01-28 13:31:42 +01:00
## Indice
2026-02-12 19:44:17 +01:00
- [Architettura](#architettura)
- [Guida utente](#guida-utente)
- [Funzionalità](#funzionalità)
- [Shortcuts tastiera](#shortcuts-tastiera)
- [Deploy con Docker](#deploy-con-docker)
- [Sviluppo](#sviluppo)
- [Test](#test)
2026-02-12 19:44:17 +01:00
---
2026-02-12 19:44:17 +01:00
## Architettura
2026-02-12 19:44:17 +01:00
```
Controller (smartphone) ──WebSocket──┐
2026-05-12 14:54:36 +02:00
├── Server Node.js ── gameState.js
Display (schermo) ──WebSocket──┘ │
└── .segnapunti/state.json
```
2026-02-12 19:44:17 +01:00
Il server è l'unica fonte di verità. Ogni azione del controller viene elaborata e trasmessa in broadcast a tutti i client connessi. Lo stato viene salvato su disco ad ogni azione e ricaricato all'avvio, sopravvivendo ai riavvii del server.
2026-02-12 19:44:17 +01:00
| Percorso | Ruolo |
|---|---|
| `http://<host>:3000/display` | Tabellone pubblico — sola lettura |
| `http://<host>:3000/controller` | Pannello operatore — gestione partita |
| `ws://<host>:3000/ws` | WebSocket endpoint |
2026-02-12 19:44:17 +01:00
2026-04-01 18:58:02 +02:00
---
## Guida utente
2026-04-01 18:58:02 +02:00
### Scenario tipico: schermo fisso + smartphone operatore
2026-04-01 18:58:02 +02:00
#### 1. Avvia il server
2026-04-01 18:58:02 +02:00
```bash
docker compose up -d
```
2026-04-01 18:58:02 +02:00
All'avvio il terminale mostra gli URL locali e di rete.
2026-01-28 13:31:42 +01:00
#### 2. Apri il display
2026-01-28 13:31:42 +01:00
Collega il PC/server allo schermo via HDMI e apri il browser a schermo intero:
2026-01-28 13:31:42 +01:00
```
http://localhost:3000/display
```
2026-01-28 13:31:42 +01:00
Se il display è su un dispositivo separato nella stessa rete:
2026-02-12 19:44:17 +01:00
```
http://<IP-del-server>:3000/display
```
2026-01-28 13:31:42 +01:00
> **Trovare l'IP:** il server lo stampa all'avvio. In alternativa usa `ip a` su Linux.
2026-02-12 19:44:17 +01:00
#### 3. Apri il controller sullo smartphone
2026-01-28 13:31:42 +01:00
Connetti il telefono alla stessa rete Wi-Fi e apri:
2026-01-28 13:31:42 +01:00
```
http://<IP-del-server>:3000/controller
```
2026-01-28 13:31:42 +01:00
> **Installazione come app:** nel browser tocca *"Aggiungi a schermata Home"* per avere il controller come icona dedicata.
2026-01-28 13:31:42 +01:00
---
## Funzionalità
2026-01-28 13:31:42 +01:00
### Display
2026-01-28 13:31:42 +01:00
- Nomi squadre con indicatore di servizio
- Punteggio del set corrente (grande, leggibile da lontano)
- Contatore set vinti
- Striscia storica punti del set in corso, scorrevole verso destra
- Modalità formazioni: posizioni dei 6 giocatori in campo
- Indicatore connessione WebSocket (scompare quando connesso, rosso lampeggiante se disconnesso)
2026-01-28 13:31:42 +01:00
### Controller
2026-01-28 13:31:42 +01:00
- **Punti** — `+1` per casa e ospite, con annullamento dell'ultimo punto
- **Dialog set vinto** — appare automaticamente al raggiungimento dei 25 punti (o 15 nel tie-break); permette di confermare il set o annullare l'ultimo punto
- **Formazioni** — configura i numeri di maglia; la rotazione avviene automaticamente al cambio palla
- **Cambi** — dialog `IN → OUT` con validazione
- **Servizio** — cambio manuale (disponibile solo a 0-0)
- **Visualizzazione** — alterna tra punteggio grande e formazioni in campo
- **Striscia** — mostra/nasconde lo storico punti sul display
- **Reset** — azzera la partita (richiede conferma)
2026-01-28 13:31:42 +01:00
### Regole pallavolo integrate
2026-01-28 13:31:42 +01:00
| Set | Condizione di vittoria |
|---|---|
| Set 14 (modalità 3/5) o 12 (modalità 2/3) | Primo a **25** con almeno 2 punti di scarto |
| Set decisivo (tie-break) | Primo a **15** con almeno 2 punti di scarto |
2026-01-28 13:31:42 +01:00
---
2026-01-28 13:31:42 +01:00
## Shortcuts tastiera
2026-01-28 13:31:42 +01:00
> Valide sul controller da browser desktop.
2026-01-28 13:31:42 +01:00
| Tasto | Azione |
|---|---|
| `Ctrl + ↑` | Punto casa |
| `Ctrl + ↓` | Annulla ultimo punto |
| `Shift + ↑` | Punto ospite |
| `Ctrl + ←` | Cambia servizio (solo a 0-0) |
| `Ctrl + M` | Apri configurazione |
| `Ctrl + C` | Cambi squadra casa |
| `Shift + C` | Cambi squadra ospite |
| `Ctrl + Z` | Toggle punteggio / formazioni |
| `Ctrl + S` | Annuncio vocale punteggio |
| `Ctrl + B` | Mostra/nascondi barra pulsanti |
| `Ctrl + F` | Fullscreen |
---
## Deploy con Docker
### Prima installazione
```bash
docker compose up -d
```
Lo stato viene salvato nel volume Docker `segnapunti-state` e sopravvive ai riavvii del container.
### Aggiornamento a nuova versione
```bash
docker compose pull && docker compose up -d
```
### Build e pubblicazione immagine
```bash
docker build \
-t santantonio.sytes.net/attilio/segnapunti:2.0.0 \
-t santantonio.sytes.net/attilio/segnapunti:latest .
docker push santantonio.sytes.net/attilio/segnapunti:2.0.0
docker push santantonio.sytes.net/attilio/segnapunti:latest
```
---
## Sviluppo
### Requisiti
| Strumento | Versione minima |
|---|---|
| Node.js | >= 18 |
| npm | >= 9 |
### Avvio
```bash
npm install
npm run dev
```
| URL | Interfaccia |
|---|---|
| `http://localhost:5173/display` | Display |
| `http://localhost:5173/controller` | Controller |
Lo stato viene salvato in `.segnapunti/state.json` anche in modalità dev.
### Comandi disponibili
| Comando | Descrizione |
|---|---|
| `npm run dev` | Dev server con hot reload |
| `npm run build` | Build di produzione in `dist/` |
| `npm run serve` | Build + avvio server produzione |
---
2026-04-01 18:58:02 +02:00
## Test
2026-01-28 13:31:42 +01:00
| Comando | Descrizione |
|---|---|
| `npm run test:unit` | Unit + integration (Vitest) |
| `npm run test:component` | Componenti Vue (Happy-DOM) |
| `npm run test:stress` | Load test WebSocket (50+ client) |
| `npm run test:all` | Tutti i test tranne E2E |
| `npm run test:e2e` | Playwright — Chromium, Firefox, Mobile Chrome |
2026-01-28 13:31:42 +01:00
> I test E2E richiedono il server in esecuzione (`npm run serve`) e i browser Playwright installati:
> ```bash
> npx playwright install chromium firefox
> ```
2026-01-28 13:31:42 +01:00
2026-02-12 19:44:17 +01:00
---
## Changelog
2026-01-28 13:31:42 +01:00
Vedere [CHANGELOG.md](CHANGELOG.md) per la storia delle versioni.