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

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
• 📋 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
• 🎭 Presets: Pre-crafted QR code styles
• 🖌️ Frame customization: Add text labels and style the frame 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.
• 📲 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

Try it out here ✨

Mini-QR can easily be self-hosted using Docker. We provide a docker-compose.yml file and a production-ready multi-stage Dockerfile.

Quick Start (using prebuilt image)

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

docker compose up -d

This will pull the latest production image from GitHub Container Registry and start the app at http://localhost:8081.

To build and run locally (for development or custom builds)

docker compose up -d --build

Or build and run manually:

docker build -t mini-qr .
docker run -d -p 8081:8080 mini-qr

You can also simply compile the application directly using NPM and Vite like follows:

git clone https://github.com/lyqht/mini-qr.git
cd mini-qr
npm install
npm run build

From there, the application will be build into dist folder and this folder can simply be hosted from any kind of web server.

An example using PHP's built-in web server:

cd dist
php -S localhost:8080

An example of a self-hosted website with a modified MiniQR app with specific language and preset: https://qrcode.outils.restosducoeur.org/

• You can edit nginx.conf or mount your own static files by uncommenting the volumes section in docker-compose.yml.
• The production image uses Nginx for optimal static file serving.
• The .dockerignore file is included for smaller, faster builds.
• Set BASE_PATH=/your-path to deploy the app under a subdirectory (e.g., for hosting at domain.com/your-path).
• If you want to have a default preset to be fixed, you should set VITE_DISABLE_LOCAL_STORAGE=true

Deploy at root path (default):

docker compose up -d

Deploy at subdirectory /mini-qr:

BASE_PATH=/mini-qr docker compose up -d

For custom builds with specific BASE_PATH:

docker build --build-arg BASE_PATH=/mini-qr -t mini-qr .
docker run -d -p 8081:8080 mini-qr

Translations and bug fixes are welcome!

See CONTRIBUTING.md for more details.

Thank you for everyone here for taking their time out to improve MiniQR 🧡

tenekev 💻 📖	Zain Fathoni 🎨	Francesco 🌍	Rahul Somasundaram 💻	tecking 🌍	David Xie 💻
Patipat Chewprecha 🌍 💻 📖	Johan Ekström 💻	Klemens Graf 💻	林都 💻 🌍	seals187 👀	olvier 👀
Matthew Berryman 💻	Mr-robot-ops 🌍	danktankk 💻	Joseph Claus 📖	Joe Simpson 📖
Add your contributions