How jeniltank/box-cricket works
Box Cricket is a live scoring and tournament-management application. An operator configures teams and a match, records ball-by-ball results, and synchronizes match state to a broadcast display; team and player rosters can also be managed separately. The repository contains both root-level browser clients and a Next.js client under extra/client. The README documents the live-sync flow, while sampled server code confirms PostgreSQL persistence and team APIs; some client wiring is documented rather than directly sampled.
Main entry points: server.js HTTP and Socket Server · admin/page.js Admin Page · SocketContext.js Socket Provider · teams/page.js Teams Page
Components 14
Match Scoring
- Scoring Dashboard
admin.js - Scoring State
extra/client/src/hooks/useMatchState.js - Input Validation
extra/client/src/hooks/useValidation.js - Admin Page
extra/client/src/app/admin/page.js
Broadcast Display
- Broadcast Renderer
broadcast.js - Broadcast Overlays
extra/client/src/components/broadcast
Team Management
- Roster Management
teams.js - Teams Page
extra/client/src/app/teams/page.js
Backend and Persistence
- HTTP and Socket Server
server.js - PostgreSQL
Next Client
- Socket Provider
extra/client/src/context/SocketContext.js
Other components
- Match Operator
- TV Viewer
- Team Manager
Connections 19
- Match Operator → Scoring Dashboard: scores match
README.md - Scoring Dashboard → HTTP and Socket Server: sends state
README.md - HTTP and Socket Server → Scoring Dashboard: broadcasts updates
README.md - HTTP and Socket Server → PostgreSQL: persists state
server.js - HTTP and Socket Server → Broadcast Renderer: broadcasts state
README.md - Broadcast Renderer → TV Viewer: renders graphics
README.md - TV Viewer → Broadcast Overlays: views overlays
README.md - Team Manager → Roster Management: manages rosters
README.md - Team Manager → Teams Page: manages rosters
README.md - Teams Page → HTTP and Socket Server: calls team APIs
extra/client/src/app/teams/page.js - HTTP and Socket Server → PostgreSQL: stores rosters
server.js - Match Operator → Admin Page: configures match
README.md - Admin Page → Scoring State: uses scoring state
extra/client/src/app/admin/page.js - Admin Page → Input Validation: validates inputs
extra/client/src/app/admin/page.js - Admin Page → Broadcast Overlays: renders overlays
extra/client/src/app/admin/page.js - Scoring State → Socket Provider: uses socket
extra/client/src/hooks/useMatchState.js - Teams Page → Socket Provider: uses socket
extra/client/src/app/teams/page.js - Socket Provider → HTTP and Socket Server: connects by Socket.IO
- Admin Page → Socket Provider: uses socket
extra/client/src/app/admin/page.js