https://github.com/lyqht/mini-qr
Scan & create pretty qr codes easily 👾
https://github.com/lyqht/mini-qr
deepl qr-code-generator shadcn-vue vite vue-i18n-next vue3
Last synced: 9 days ago
JSON representation
Scan & create pretty qr codes easily 👾
- Host: GitHub
- URL: https://github.com/lyqht/mini-qr
- Owner: lyqht
- License: gpl-3.0
- Created: 2023-04-21T14:20:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-13T10:20:45.000Z (10 days ago)
- Last Synced: 2025-04-14T02:58:31.297Z (9 days ago)
- Topics: deepl, qr-code-generator, shadcn-vue, vite, vue-i18n-next, vue3
- Language: Vue
- Homepage: https://mini-qr-code-generator.vercel.app
- Size: 22 MB
- Stars: 1,069
- Watchers: 6
- Forks: 128
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Mini QR
[](https://www.gnu.org/licenses/gpl-3.0)
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 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
### 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](https://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](https://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](https://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](https://mini-qr.vercel.app/) ✨
https://github.com/lyqht/mini-qr/assets/35736525/991b2d7e-f168-4354-9091-1678d2c1bddb
Batch data export (added in v0.9.0)
https://github.com/user-attachments/assets/fef17e6a-c226-4136-9501-8d3e951671e0
Scanning QR code (added in v0.13.0)
https://github.com/user-attachments/assets/5ad58b35-0a16-43a4-839a-e2197bfc273a
Basic frame settings (added in v0.15.0)
https://github.com/user-attachments/assets/e160d60d-3c7f-4bbb-908c-efd11fec20e8
## Self-hosting with Docker 🐋
Mini-QR can easily be self-hosted. We provide a [docker-compose.yml](docker-compose.yml) file as well as our own images. We are using GitHub's `ghrc.io` Container Registry.
```bash
wget https://github.com/lyqht/mini-qr/raw/main/docker-compose.yml
docker compose up -d
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.