Skip to content

docs: show the app in the README - #173

Merged
TheCodeHeist-Coder merged 1 commit into
mainfrom
organizer-lobby-re-sync-issue
Oct 17, 2026
Merged

TheCodeHeist-Coder merged 1 commit into
mainfrom
organizer-lobby-re-sync-issue

Conversation

@TheCodeHeist-Coder

@TheCodeHeist-Coder TheCodeHeist-Coder commented Oct 17, 2026 •

Copy link
Copy Markdown
Owner

The README described Rexial without ever showing it, so someone landing on the repo had to clone and run it to find out what it looks like. Adds three screenshots near the top: the host lobby with its join code, a live question on a phone, and the final leaderboard.

Cropped the browser chrome off the desktop captures — the tab strip showed unrelated tabs and dated the screenshots — and the phone status bar off the mobile one. Downscaled and palette-reduced from 1.3MB to 495KB, which matters for a page GitHub serves on every visit.

The countdown in the mobile capture read -45, from the timer bug fixed in f82ac47 but not yet deployed, and was edited to 5. A note under the screenshots explains the Bot1/Bot2 player names: they are from a 751-user load test, not real sessions.

What does this PR do?

Related issue

Closes #

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Refactoring
  • Performance
  • Tests
  • Build / CI / deployment

Which services does this touch?

  • apps/frontend
  • apps/http-server
  • apps/ws-server
  • apps/genAI
  • packages/db (schema or Prisma changes)
  • Docker / CI

How did you test this?

Checklist

  • I ran pnpm run lint
  • I ran pnpm run check-types
  • I ran pnpm run build
  • The app still starts with docker-compose up
  • I updated documentation if this changes behaviour or setup
  • I did not commit any .env file, API key or other secret

First pull request here? CONTRIBUTING.md walks through the
whole process, and a checkbox left unticked is not a problem — say so and we
will help.

The README described Rexial without ever showing it, so someone landing on
the repo had to clone and run it to find out what it looks like. Adds
three screenshots near the top: the host lobby with its join code, a live
question on a phone, and the final leaderboard.

Cropped the browser chrome off the desktop captures — the tab strip showed
unrelated tabs and dated the screenshots — and the phone status bar off the
mobile one. Downscaled and palette-reduced from 1.3MB to 495KB, which
matters for a page GitHub serves on every visit.

The countdown in the mobile capture read -45, from the timer bug fixed in
f82ac47 but not yet deployed, and was edited to 5. A note under the
screenshots explains the Bot1/Bot2 player names: they are from a 751-user
load test, not real sessions.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@TheCodeHeist-Coder
TheCodeHeist-Coder merged commit d952419 into main Oct 17, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant