Skip to content

lyqht/mini-qr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

81 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Mini QR

License: GPL v3

An app to create beautiful QR codes and scan various QR code types.

Features

  • βœ… Accessible: minimally WCAG A compliant
  • 🎨 Customizable colors and styles
  • πŸ–ΌοΈ Export to SVG and PNG
  • πŸ“‹ Copy to clipboard
  • πŸŒ“ Light/dark/system-preference mode toggle
  • 🎲 Randomize style button
  • 🌐 Available in 29+ languages thanks to deepl-translate-github-action
  • πŸ’Ύ Save & Load QR Code config
  • πŸ–ΌοΈ Upload custom image for logo
  • 🎭 Presets: Pre-crafted QR code styles
  • πŸ›‘οΈ 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.
  • πŸ“² PWA Support: Install MiniQR as a desktop or mobile app

Installation as PWA

MiniQR can also be installed as a Progressive Web App (PWA) on your device
  1. Desktop (Chrome/Edge):

    • Visit mini-qr.vercel.app
    • Click the install icon (βž•) in the address bar
    • Click "Install" in the prompt
  2. Mobile (Android):

    • Visit mini-qr.vercel.app
    • Tap the "Add to Home Screen" option in your browser menu
    • Tap "Install" or "Add"
  3. iOS (Safari):

    • Visit mini-qr.vercel.app
    • Tap the Share button
    • Scroll down and tap "Add to Home Screen"
    • Tap "Add"

Once installed, MiniQR will work offline and provide a native app-like experience.

Demo

Try it out here ✨

MiniQR-demo.mp4

Batch data export is also now supported.

batch_data_export.mp4

Scanning QR codes is also possible at MiniQR.

Demo-QRScan.mp4

Self-hosting with Docker πŸ‹

Mini-QR can easily be self-hosted. We provide a docker-compose.yml file as well as our own images. We are using GitHub's ghrc.io Container Registry.

wget https://github.com/lyqht/mini-qr/raw/main/docker-compose.yml

docker compose up -d

Contributing

See CONTRIBUTING.md for more details.