Skip to content

Redesign the README: banner, journey cards and an MIT license - #1

Merged
operatoruplift merged 6 commits into
mainfrom
claude/readme-redesign
Oct 31, 2026
Merged

operatoruplift merged 6 commits into
mainfrom
claude/readme-redesign

Conversation

@operatoruplift

@operatoruplift operatoruplift commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

What changed

The README was accurate but text only. This PR presents every fact and instruction in it in the same house style as the Allowance README, and it is up to date with main at 1e15909, including the Supabase backend.

  • Header: a banner with the app on three phones (the quest log, home at level 3, Messages), three buttons (open the app, try Preview mode on the Settings screen, read the proposal), badges for the live app, the event in planning, the PWA, the Supabase backend, no build step or npm dependencies, the 51 tests and the license, the app's own line "Every step from the waitlist to your demo is a quest", the Join → Pre-register → Check in → Team up → Submit loop, and section links.
  • Screens card: four phone screens in journey order, light and dark: the path with the next step in gold, a saved pre-registration ("Saved on this device and to your Dragon Connector account"), the QR pass with its event-day note, and Teammates with the empty list of real builders above the labelled sample profiles.
  • How it works: a flow card from the builder to the app, Supabase and the organizers, with the XP loop; three guarantees taken from the code (XP is derived, matches carry reasons, the Guide only repeats event data); and the seven journey steps with the XP each one's quest is worth, as Home shows it.
  • Honest by design: all seven rules from main's README (plain about data, consent for older data, hidden profiles, Preview mode, sample profiles, no sponsors, planned prizes) as a table, plus the sentence on what the tests enforce.
  • Status: LIVE (the app), LIVE (the Supabase services, with the anonymous sign-in caveat), PROPOSAL (the event), CLOSED (registration, check-in and submission, and Preview mode) and PLANNED (its own domain), each with a link.
  • Live services: main's Supabase section in full: the project, the anon key rule, where data lives, the one-time dashboard settings, the organizer runbook (in a collapsible section) and how to change the database. Added: how to point a copy at another project, since tests/content.test.mjs requires INTEGRATIONS.supabase and the connect-src in vercel.json to name the same one.
  • Run it locally now opens with a warning: a local copy talks to the live project, so saving, messaging or opening Teammates on localhost creates a real anonymous account.
  • Kept in full: run, test, change event facts, PWA, deploy, the project structure (a Repository layout table in a collapsible section) and the credits (the footer's license line, now with supabase-js). Nothing was dropped.

Merged from main. main moved twice while this PR was open: the Supabase backend (7443037) and the privacy copy fix (1e15909). Merged in 5133393, where only README.md conflicted; 030afc3 rewrites the README from main's text.

Fixes, as separate commits:

  • LICENSE: MIT, "Copyright (c) 2026 Operator Uplift", byte-identical to operatoruplift/webview's. The footer says the MIT license covers the code, while the fonts keep the SIL Open Font License (public/fonts/OFL-*.txt) and the vendored qrcode-generator and supabase-js keep their MIT notices (public/src/vendor/).
  • package.json: license, homepage and repository fields.
  • README corrections: earlier commits on this branch corrected the waitlist POST payload and the check-in code hashing. main has since replaced both with Supabase (the waitlist table and event_secrets), so those passages are gone. The paragraph on tests that pin today's state now names what main pins: the fallback GATES.registration.open, INTEGRATIONS.registrationUrl and SPONSORS.

All images live in docs/readme/ (five PNGs, 872 KB). The live site is not reachable from this environment, so the screenshots were captured from a local static server on 31 October 2026. They use the demo builder that scripts/render-assets.cjs uses for the install screenshots, with the in-memory Supabase from tests/fake-supabase.mjs standing in for the client and every request to anything but the local server blocked, so nothing reached the live project. Nothing in public/ changed, so the precache list is still current.

Checks

  • npm test on the merged branch: 51 of 51 pass. Vercel built this PR's head (its build step is npm test) and deployed the preview.
  • Browser pass with Playwright and Chromium on the merged code, against python3 -m http.server on public/ with the in-memory Supabase: 20 routes, phone and desktop, new and seeded state, 80 page loads. No console errors, page errors, HTTP errors or horizontal overflow; the only warnings came from the harness blocking the service worker. No request went anywhere but the local server.
  • public/src/vendor/qrcode.mjs is byte-identical to dist/qrcode.mjs in qrcode-generator 2.0.4 from npm, and public/src/vendor/supabase.js is supabase-js 2.118.0, as the README says.
  • README check: no errors, 60 links and images, no em or en dashes, alt text on every image. Previewed as GitHub renders it in light and dark.
  • Not run: npm run assets, which re-renders the committed icons and install screenshots. Not checked: whether anonymous sign-ins are switched on in the live project. The README says what the app does either way.

Suggested repository settings

This environment cannot change repository settings, so the About section needs the commands below or the gear icon next to About.

  • Description: "Installable participant app for Dragon Connector, a proposed Solana Mobile and AI hackathon in Da Nang. Every step is a quest: waitlist, pre-registration, a QR check-in pass, teammate matching, live messages and teams on Supabase, and the Dragon Guide. Works offline."
  • Website: already https://dragonconnectorapp.vercel.app. Keep it.
  • Topics: pwa, hackathon, solana-mobile, supabase, gamification, offline-first, service-worker, vanilla-js, event-app, qr-code, team-matching, da-nang, vietnam
  • Social preview: upload docs/readme/banner.png.
gh api -X PATCH repos/operatoruplift/dragonconnector -f description="Installable participant app for Dragon Connector, a proposed Solana Mobile and AI hackathon in Da Nang. Every step is a quest: waitlist, pre-registration, a QR check-in pass, teammate matching, live messages and teams on Supabase, and the Dragon Guide. Works offline." -f homepage="https://dragonconnectorapp.vercel.app" --silent
gh api -X PUT repos/operatoruplift/dragonconnector/topics -f "names[]=pwa" -f "names[]=hackathon" -f "names[]=solana-mobile" -f "names[]=supabase" -f "names[]=gamification" -f "names[]=offline-first" -f "names[]=service-worker" -f "names[]=vanilla-js" -f "names[]=event-app" -f "names[]=qr-code" -f "names[]=team-matching" -f "names[]=da-nang" -f "names[]=vietnam" --silent

https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5


Generated by Claude Code

- MIT, copyright 2026 Operator Uplift, the same terms as
  operatoruplift/cold and operatoruplift/webview
- Covers the code only: the fonts keep the SIL Open Font License
  (public/fonts/OFL-*.txt) and the vendored qrcode-generator keeps
  its MIT notice (public/src/vendor/)

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- license: MIT, matching the new LICENSE file
- homepage: https://dragonconnectorapp.vercel.app, the address the
  Vercel project serves
- repository: operatoruplift/dragonconnector

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- The waitlist POST body also carries `sent: false`, and any 2xx
  response marks the entry as sent (views/waitlist.js)
- The app trims, upper-cases and strips spaces from the venue code
  before hashing it, so a hash made from any other form never matches
  (views/checkin.js, normaliseCode)
- Changing event facts also needs `npm run precache`, and opening
  registration, setting an integration or naming a sponsor fails the
  tests that pin today's state (and so the Vercel build) until those
  tests change too; checked by flipping each value in a scratch copy

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- Header: banner with the app on three phones, buttons for the app,
  Preview mode and the proposal, live and fact badges, the journey loop
- Screens card: the path, pre-registration, the check-in pass and
  teammate matching, captured from a local build in Preview mode with
  the demo builder from scripts/render-assets.cjs
- How it works: builder, app and proposal flow card, three guarantees
  and the seven journey steps with the XP each quest is worth
- Status table: live app, proposed event, preview-only steps, planned
  services; every honest-by-design rule kept
- Run, configure, PWA and deploy sections keep every instruction; the
  footer says what the MIT license covers and what keeps its own

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
@vercel

vercel Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
dragonconnectorapp Ready Ready Preview Oct 31, 2026 4:53am UTC

Request Review

Brings in accounts, the waitlist, messages, teams, submissions and check-in on
Supabase, so the README can describe them. README.md keeps this branch's
version here; the next commit rewrites it for the live services.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
The README said everything people enter stays on their own device and listed
real services as planned. Accounts, the waitlist, messages, teams,
submissions and check-in now run on Supabase, so:

- the summary, the steps, Honest by design and Status describe the live
  services, anonymous accounts, hidden profiles and Delete my data;
- Run it locally warns that a local copy talks to the live project;
- Live services carries the dashboard settings, the organizer runbook and
  how to change the database, from main's README, word for word;
- the screens and banner are recaptured from the merged code, connected to
  the in-memory Supabase from tests/fake-supabase.mjs with every other
  request blocked, so nothing reached the live project;
- the flow card adds Supabase and the organizers; the test count is 51.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
@operatoruplift
operatoruplift merged commit a8a1648 into main Oct 31, 2026
2 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.

2 participants