Skip to content
mlziadePublic

About

A shared, real-time football league table with live cursors. The hosted site was retired; the code is open source under MIT.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

LiveBoard

The hosted site has been retired, and the code is now open source under the MIT license. LiveBoard used to run at liveboard.mlziade.com.br. I could not justify the API-Football plan behind it, so I shut it down and opened the code instead. Clone it, run it, adapt it for your league, your friends or your stream. To get a copy running, start with docs/RUNNING-AND-DEPLOYING.md.

LiveBoard is a shared, real-time football league table. You open a room, share the link, and everyone in it fills in the scores of games that haven't happened yet. The standings recompute for everyone at once, and you can see each other's cursors moving across the page. Real results come in on their own from API-Football while games are played.

Home

What it does

  • Live rooms. Everyone in a room shares the same table, live cursors, a presence roster and per-field typing highlights. Rooms can be guest-only, or you can sign in with Google. Rooms can have passwords, an admin who can kick people, and a "bolão" mode that locks guesses at kickoff.
  • 34 competitions. Leagues, cups with knockout brackets and hybrid formats (Brasileirão A/B/C, Premier League and EFL, La Liga, Serie A, Bundesliga, Ligue 1, Libertadores, Champions League, and more), each with its own tiebreakers and standings zones.
  • Real vs. simulated table, plus rewind. Switch between the real standings and the ones your guesses produce, or rewind the table to any round or date.
  • Insights. Form, home/away splits, streaks, attack and defense rankings, xG and xGC "expectations", the swing between the first and second half of the season, discipline, the top and bottom 4 by round, and a position-timeline chart.
  • Daily games and club pages. A per-day scoreboard with live events, and club pages with fixtures, squad, stats and a club search.
  • A demo room at /demo with bot cursors and a guided tour.
  • Three languages: Portuguese, English and Spanish, plus light and dark themes.
Room with live cursors Position timeline
Daily games Club page
Rewind the table Dark mode

More screenshots are in prints/.

Repo layout

Two fully independent apps, with no shared package:

  • frontend/: the Next.js (TypeScript) UI. It talks to realtime/ over REST and Socket.io only and holds no data of its own.
  • realtime/: a Node/Express/Socket.io service. It owns PostgreSQL (via Prisma), Redis, the standings engine and the fixture-ingestion jobs.

Quick start

docker compose -f docker-compose.dev.yml up -d postgres redis

cd realtime && cp env.example .env && npm install
npm run prisma:migrate && npm run seed && npm run dev

cd ../frontend && cp env.example .env && npm install && npm run dev

The frontend runs at http://localhost:3000 and the realtime service at http://localhost:4000. To load real fixtures, set API_FOOTBALL_KEY and run npm run ingest in realtime/. The full walkthrough, configuration and production deployment are in docs/RUNNING-AND-DEPLOYING.md.

Documentation

Doc Covers
docs/RUNNING-AND-DEPLOYING.md Start here. From clone to local dev to a deployed server
docs/architecture.md Top-level architecture, tech stack, and how the two apps fit together
docs/features.md Everything the product does, in detail
docs/architecture_auth_and_permissions.md Guest vs. Google identity, session tokens, room ownership, passwords and admin
docs/multiplayer.md Live presence, cursors, guess sync and the room roster
docs/database_and_migrations.md Postgres schema, the Redis cache-aside layer, migrations, schema.dbml
docs/security.md What's hardened, known gaps, and a checklist before exposing it publicly
docs/deployment.md Compose files, Dockerfiles, env vars and the reverse proxy
docs/running.md Every script, env var and port
docs/admin_panel.md The AdminJS operator panel
docs/crests.md Where club crests come from and how they're synced

Background research: docs/research-realtime-architecture.md (why the realtime service is a separate long-running process) and docs/research-competition-rules.md (where tiebreakers and standings zones come from).

A note on data and assets

  • Match data comes from API-Football, and you need your own key. Check their terms before running a public instance.
  • Club crests in realtime/crests/ are mirrored from Wikimedia Commons (realtime/crests/manifest.json maps each file to its source URL, and docs/crests.md explains the sync). They are club trademarks, and the MIT license below doesn't cover them.
  • The profanity lists in realtime/src/moderation/datasets/ keep their own license (LDNOOBW_LICENSE.txt).

License

MIT. Use it, fork it, change it, ship it. A link back is appreciated.

About

A shared, real-time football league table with live cursors. The hosted site was retired; the code is open source under MIT.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages