Create & scan cute qr codes easily πΎ
npm install mini-qrMini QR
An app to create beautiful QR codes and scan various QR code types.
Features
Review of 'MiniQR' that makes it easy to create good-looking QR codes - Gigazine, an Osaka based tech news website, one of the top 25 news sites by TIME.com
- β Accessible: minimally WCAG A compliant
- π¨ Customizable colors and styles
- πΌοΈ Export to PNG, JPG & SVG
- π€ Export to ASCII / Unicode text
- π Copy to clipboard
- π Light/dark/system-preference mode toggle
- π² Randomize style button
- π Available in 30+ languages
- πΎ Save & Load QR Code config
- πΌοΈ Upload custom image for logo with adjustable size and margin
- π Presets: Pre-crafted QR code styles
- ποΈ Frame customization: Add a frame containing text and a background around your QR code.
- π‘οΈ Error correction level: affects the size of the QR code and logo within. Use lower correction levels for bigger pieces of data to ensure that it can be read.
- π± QR Code Scanner: Scan QR codes using your camera or by uploading images, with intelligent detection for URLs, emails, phone numbers, WiFi credentials, and more
- π¦ Batch data export: Import a CSV file with multiple data strings and export QR codes for them all at once. Template CSV files can be found in
public/batch_export_templates/. - π² PWA Support: Install MiniQR as a desktop or mobile app
- π Data templates: Support for various data types including text, URLs, emails, phone numbers, SMS, WiFi credentials, vCards, locations, and calendar events
- π UTF-8 input support: Vietnamese, CJK, Arabic, emoji, and other multibyte text
See ROADMAP.md for future planned features.
Demo
Try it out here β¨
Browse the component library (the internal QR-code rendering lib) in Storybook at mini-qr-storybook.vercel.app π
Frame text included in batch export (added in v0.17.0)
https://github.com/user-attachments/assets/c6db8fd5-ec36-43be-b6e3-a42e1b7dc3cb
Data templates (added in v0.16.0)
https://github.com/user-attachments/assets/863f9330-2645-4d23-88aa-04f5f5beaa67
Basic frame settings (added in v0.15.0)
https://github.com/user-attachments/assets/e160d60d-3c7f-4bbb-908c-efd11fec20e8
Scanning QR code (added in v0.13.0)
https://github.com/user-attachments/assets/5ad58b35-0a16-43a4-839a-e2197bfc273a
Batch data export (added in v0.9.0)
https://github.com/user-attachments/assets/fef17e6a-c226-4136-9501-8d3e951671e0
MVP - presets, languages, dark/light mode (v0.3.0)
https://github.com/lyqht/mini-qr/assets/35736525/991b2d7e-f168-4354-9091-1678d2c1bddb
Self-hosting
For full self-hosting instructions including Docker setup, environment variables, custom presets, and deployment scenarios, see SELF_HOSTING.md.
Contributing
Translations & bug fixes are welcome! For all other matters, before opening an issue or contacting the project maintainer, please read up on to CONTRIBUTING.md.
Component stories live in Storybook (pnpm storybook locally, or the production build at mini-qr-storybook.vercel.app). Pull requests that touch the UI get an auto-deployed Storybook preview on Vercel β see docs/storybook-vercel-previews.md for how it's wired up.
Maintainers: see RELEASING.md for how releases are cut (automated via release-please + Crowdin).
Release process: Automated with release-please (versioning, tagging, GitHub Release, and
public/CHANGELOG.md) and the Crowdin GitHub integration (translations). See RELEASING.md.
Thank you for everyone here for taking their time out to improve MiniQR π§‘
