qr-codes / README.md
evalstate's picture
evalstate HF Staff
Add logo sizing and optional editable header to preview and PNG/SVG exports
faa32d1 verified
|
Raw History Blame Contribute Delete
1.51 kB
metadata
title: Signal QR Studio
emoji: 📟
colorFrom: green
colorTo: gray
sdk: static
app_file: index.html
pinned: false
short_description: Retro-terminal QR codes with a Hugging Face pirate twist.

Signal / QR Studio

A browser-only QR generator with green phosphor, amber console, and arctic terminal themes. Includes an optional Hugging Face pirate logo, high error correction, and self-contained SVG / 1024px PNG exports. URLs are encoded locally, with no redirect or tracking service. Google Fonts supplies the interface fonts; the QR generation itself makes no network requests.

Development

npm ci
npm run dev

Build: npm run build. Upload the contents of dist/ to the Space root after rebuilding; source files live under source/ on the Space.

Tests: npx playwright install chromium, start the dev server, then npm test. Tests decode all three PNG exports, check invalid input, SVG download, logo toggle, and mobile overflow.

Logo: https://huggingface.co/datasets/huggingface/brand-assets/blob/main/hf-logo-pirate.png

Always test your final QR at its intended print size with your phone, especially when adding a logo or using a long URL. Logo size is adjustable from 12% to 26%. Downloads contain the themed QR and logo, plus an optional editable header (up to 40 characters), with no footer. Header settings apply to PNG and SVG. Automated scan tests cover 12%, 17%, 22%, and 26% in all themes for the default URL; other URLs and real-world cameras may behave differently.