# Freebee docs

> Freebee is a measured-audience mall-screen advertising platform (DOOH): advertisers book screens and run video, image or game ads; ops run the screens; shoppers play on the wall and win coupons. These documents describe what the product does, where it stands, and the contracts the code is built against.

Site: https://freebeeads.com · Full text of every doc in one file: https://freebeeads.com/llms-full.txt

## Product docs

- [Status board](https://freebeeads.com/docs/md/status.md): What is done, what is half done and what is still to do across the whole platform, with a priority on each line. Start here before planning any work.
- [End-to-end flow](https://freebeeads.com/docs/md/flow.md): Who does what, in what order, from an advertiser signing up to the next-morning report — plus links, metrics, booking, bidding, failures, OTP, AI and the native player.
- [UI/UX analysis and plan](https://freebeeads.com/docs/md/ui-plan.md): Where the three web surfaces stand, what the reference dashboards do better, the new information architecture, and the page-by-page restructure with its rollout.
- [All diagrams](https://freebeeads.com/docs/diagrams): every drawing from the product docs, each with a one-line reading (HTML page; the markdown files describe each diagram in place).

## Engineering docs

- [API contract](https://freebeeads.com/docs/md/repo/api-contract.md): The v1 HTTP contract both the FastAPI backend and the web app are built against.
- [Cricket design](https://freebeeads.com/docs/md/repo/cricket-design.md): Hit for Six — the cricket wall, the kiosk, the code, the dice and the prize bands.
- [Cricket storyboards](https://freebeeads.com/docs/md/repo/cricket-storyboards.md): Every ball on the wall as a three-beat scene, and what the commentator says.
- [Deploy](https://freebeeads.com/docs/md/repo/deploy.md): How the backend (Railway) and the web app (Vercel) ship from one GitHub repo.
- [Design doc](https://freebeeads.com/docs/md/repo/design-doc.md): The locked premises and the system design the platform was built on.
- [Mobile spec](https://freebeeads.com/docs/md/repo/mobile-spec.md): One Flutter app for both advertisers and ops, role-gated at runtime.
- [Native player plan](https://freebeeads.com/docs/md/repo/native-player-plan.md): The software installed on the screen device: shells per platform, registration, offline, updates, hardware and the build order.
- [Reference sites](https://freebeeads.com/docs/md/repo/reference-sites.md): Copy and design inventory of the sites the marketing site is modelled on.
- [Secrets rotation](https://freebeeads.com/docs/md/repo/secrets-rotation.md): How to rotate the Railway secrets without losing wallet phones or locking anyone out, in the right order.
- [Support and incidents](https://freebeeads.com/docs/md/repo/support-and-incidents.md): How advertisers reach us, and the numbered runbooks for a screen down, a wrong ad playing, an OTP outage, a hosting outage and an erasure request.
- [Backups](https://freebeeads.com/docs/md/repo/backups.md): Manual Postgres and media-volume backups on Railway, where to store them, the monthly restore drill and the retention rule.
- [Player setup](https://freebeeads.com/docs/md/repo/player-setup.md): How to make a Windows mini PC, a Mac mini or an Android box open the wall on boot, what the Devices page shows, and the remote fixes.
- [Testing and CI](https://freebeeads.com/docs/md/repo/testing.md): How to run the backend tests, the web build and the Playwright journeys locally, and what GitHub Actions runs on every push.
- [Uptime and error tracking](https://freebeeads.com/docs/md/repo/uptime.md): The two monitors to create, what to alert on, and how Sentry is wired behind environment variables with no personal data.
- [Product analytics](https://freebeeads.com/docs/md/repo/analytics.md): The events we track on ourselves, the sign-up to first-booking funnel, and days to first booking.
- [UI standard](https://freebeeads.com/docs/md/repo/ui-standard.md): The one light system: tokens, type scale, registers, and the app shell.