0 Fork 0

mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2026-10-27 09:40:40 +00:00

Files

T

thePR0M3TH3ANandClaude Opus 4.8 c5b2c20fc9 Add cross-browser e2e tests, field-limit cheat sheet, and docs

Verification:
- Add Playwright harness (e2e/) covering Chromium, Firefox, and WebKit plus
  Android/iOS mobile emulations. Smoke tests assert: default flyer renders
  with no JS/console errors, @media print hides app chrome and keeps the
  flyer, anonymous npub generation (WebCrypto), legacy /nostr/ redirect
  preserves query+hash, and event-lookup URLs show the loading state instead
  of the default flyer. All six projects pass.
- package.json/playwright.config.js wire up the projects and a managed static
  server; .gitignore excludes node_modules and Playwright output.

Docs:
- docs/flyer-field-limits.md: per-script character cheat sheet for each flyer
  field (single-line caps + multi-line guidance), measured by rendering each
  script at print size.
- README: add a Features section matching the shipping client and a
  cross-browser verification section; link the cheat sheet.
- AGENTS.md: document the e2e suite and the one-time WebKit Linux dep.

Co-Authored-By: Claude Opus 4.8 <[email protected]>

2026-06-09 15:29:49 -04:00

4.8 KiB

Raw Blame History

VoxVera

VoxVera is a static, Nostr-powered flyer client.

The active app lives at the site root (site/). It lets anyone author flyer content, publish it as a public Nostr event, and re-render or reprint the flyer later from a Nostr address or event ID — no application server. The frontend is intentionally self-contained: Nostr relays store the content, and any static host can serve the client.

The previous Tor/OnionShare CLI version is preserved on the legacy-tor branch.

Features

Author and publish. Fill in the flyer fields and publish them as a Nostr 30078 parameterized replaceable event. Republishing with the same flyer name replaces the previous version.
Anonymous by default. The client generates an anonymous browser-side key to sign events. A NIP-07 browser extension is detected and used if present, but is never required.
Open from a link or ID. Load a flyer from an naddr, nevent1, note1, raw 64-char event ID, or nostr: URL. The lookup field tolerates copy/paste whitespace and newlines, so an event ID copied off a printed tear-off (where it wraps across two lines) still resolves.
Short, scannable poster URLs. Each poster URL is a standard NIP-19 naddr carrying a single relay hint, placed in the URL #fragment (no ?addr= query). Shorter URLs make the tear-off QR code easier to scan. Older relay-list naddrs and ?addr= URLs still resolve.
Tear-off tabs. The printable flyer has ten tear-off tabs. Each tab is a single hyperlinked call to action (the URL is the link, not printed as text) and prints the full event ID so anyone can re-find the flyer by typing it.
Loading state on shared links. Opening a poster/event link shows a localized "Loading content…" placeholder (and a "Could not load this flyer." state on failure) instead of the default flyer; the default sample content appears only on the bare site URL.
14 languages with RTL support. Flyer content and UI are localized; right-to-left scripts render correctly. Letter-spacing is applied per script so cursive (Arabic/Persian) and combining (Devanagari) scripts are not broken — see the spec.
Fits-the-page editing. Fields that would overflow the printable sheet are rejected as you type, with an inline error under the affected field. See the field length cheat sheet for how much text fits each field per language.
QR codes. The tear-off QR points at the poster URL (re-open and reprint); the main flyer QR points at the creator's content URL.
Self-contained. No build step and no CDNs — Nostr and QR libraries are vendored under site/vendor/.

What Is In `main`

site/index.html, site/nostr-client.js, site/nostr-client.css, site/locales.js: static editor/viewer client
site/vendor/: vendored browser dependencies for Nostr and QR generation
site/nostr/index.html: redirect stub so legacy /nostr/ poster URLs and QR codes still resolve
site/CNAME: custom-domain target
voxvera/nostr/: small Python schema/validation helpers
docs/nostr-static-client-spec.md: design notes and development plan
docs/flyer-field-limits.md: per-language field length cheat sheet

Local Development

Run the static site from the repo root:

python3 -m http.server 8768 --directory site

Then open:

http://127.0.0.1:8768/

No build command is required for the frontend.

Vercel

Point Vercel at this repository on main.

Framework preset: Other
Root directory: repo root
Build command: leave empty
Output directory: site

The client is served from the domain root (site/index.html). site/nostr/index.html is a redirect stub that forwards the legacy /nostr/ path to the root while preserving the query/fragment, so older poster URLs and printed QR codes still resolve.

Verification

node --check site/nostr-client.js   # client syntax
pytest -q                           # Nostr source schema

Cross-browser end-to-end tests

Playwright smoke tests run the client on Chromium, Firefox, and WebKit (Safari's engine), plus Android/iOS mobile emulations — covering rendering, the @media print path, WebCrypto key generation, the /nostr/ redirect, and the loading state.

npm install
npx playwright install     # download the browser engines
npm run test:e2e

See e2e/README.md for per-engine coverage and the one-time Linux step for WebKit (sudo npx playwright install-deps).

The Python tests only cover the Nostr source schema. The frontend is static; the Playwright suite covers engine behavior, but real Safari/iOS print and clipboard behavior is still worth a manual pass before a release.

4.8 KiB Raw Blame History