Skip to content

dipcb05/QuickQR

Repository files navigation

QuickQR

Just Scan It

QuickQR exists to avoid excessive ads and unnecessary permissions for a simple scan. It’s open-source, ad-free, privacy-first, offline friendly Progressive Web App.


Usage

  1. Scan via Camera: Launch the scanner and point your camera at any QR code or Barcode.
  2. Scan via File: Tap the file icon on the scanner page to upload a saved image.
  3. Connect to WiFi: Simply scan a WiFi QR, and tap the "Connect" button in the result modal.
  4. Offline Use: Once opened once, QuickQR is cached. You can open it anytime without an internet connection to view history or scan.

Features

  • Smart WiFi Detection: Scanning a WiFi QR code provides a direct connection prompt on supported platforms.
  • Image Decoding: Scan QR codes directly from your image gallery or file system.
  • Privacy-First Architecture: No trackers, no ads. All scan history is stored locally on device.
  • PWA (Progressive Web App): Install it on iOS (Add to Home Screen) or Android/Desktop for a standalone app experience that works offline.
  • Scan History: Saves your scans with date, time, and type for easy access later.

Getting Started

Prerequisites

Installation

  1. Clone the repo:

    git clone https://github.com/dipcb05/QuickQR.git
    cd QuickQR
  2. Install dependencies:

    pnpm install
  3. Run the development server:

    pnpm dev
  4. Build for production:

    pnpm build
    pnpm start

Contributing

QuickQR is open-source and contributions are what make the community amazing!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support

If QuickQR has helped you, consider supporting the development!

Buy Me A Coffee

📄 License

Distributed under the MIT License. See LICENSE for more information.


About

Full Scale QR Code Scanning PWA

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages