Skip to content

Home

Jump to bottom
Tushar patel edited this page Nov 15, 2025 · 2 revisions

Scan Me – QR Verification & Scanning App for Frappe

Scan Me is a lightweight, secure, and easy-to-use QR code generation and document verification app built for the Frappe/ERPNext framework. It enables fast QR creation, real-time scanning, and instant verification of any document inside your ERP system.

🚀 Features

✅ QR Code Generation

  • Generate QR codes for any Frappe Document
  • Supports custom size, color, clarity, and optional logo embedding
  • Jinja template helper for generating QR codes in print formats and pages

✅ Real-Time QR Scanning

  • Browser-based camera scanner
  • Uses secure HTML5-Qrcode library
  • No video recording or storage
  • Works on desktops and mobiles

✅ Document Verification

  • Verifies documents using secure UUID-based verification
  • Prevents tampering
  • Built-in rate limiting to prevent abuse

✅ Easy Integration

  • Works with Frappe Web Pages, Print Formats, Doctypes, and Web Forms
  • Simple API endpoints
  • Minimal dependencies
  • Clean and extensible Python code

📦 Installation

1. Get the App

bench get-app https://github.com/Tusharp21/scan-me

2. Install in your site

bench --site yoursite.com install-app scan_me

3. Restart Bench

bench restart

Your app is ready to use.

🔧 Jinja Usage (QR Helper)

Use this inside your print format or HTML:

{{ qr_link("DocType", doc.name) }}

Optional parameters:

{{ qr_link("DocType", doc.name, clarity=8, fill_color="black", back_color="white", include_logo=False) }}

📚 Documentation

Full documentation is available in the Wiki:

👉 https://github.com/Tusharp21/scan-me/wiki

🔐 Privacy & Policies

🆘 Support

For support, bug reports, or feature requests:

👉 https://github.com/Tusharp21/scan-me/issues

❤️ Contributing

Contributions are welcome:

  1. Fork the repository
  2. Create a new branch
  3. Commit your changes
  4. Open a pull request

📄 License

This project is open-source and available under the MIT License.

Scan Me – Simple. Secure. Fast. QR validation built for modern Frappe applications.

Clone this wiki locally