Skip to content

QuickQR is a lightweight, modern web application that instantly generates QR codes through both a clean web interface and a flexible REST API. Built with Quarkus, Kotlin, and Gradle (Kotlin DSL).

License

Notifications You must be signed in to change notification settings

fotioudim/quick-qr

Repository files navigation

logo

QuickQR

Instant, sleek, scannable – your QR codes, simplified!

Last commit Issues Forks Stars License: MIT


📔 Table of Contents

🌟 About the Project

QuickQR is a lightweight, modern web application that instantly generates QR codes through both a clean web interface and a flexible REST API. Built with Quarkus, Kotlin, and Gradle (Kotlin DSL), the app emphasizes speed and simplicity. The frontend is rendered using the Qute templating engine, offering a polished HTML interface, while the REST API supports seamless integration with other services.

Whether you're sharing links, contact details, or custom text, QuickQR offers a seamless experience with clean design and developer-friendly architecture.

📚 Tech Stack

The tech stack of this project consists of the following main technologies/frameworks/tools:

  • Quarkus
  • Kotlin
  • Gradle with Kotlin DSL

📓 Documentation

Based on https://www.nayuki.io/page/qr-code-generator-library and inspired by https://myfear.substack.com/p/how-to-generate-qr-codes-in-quarkus

Useful documentation for Quarkus-Kotlin-Gradle with Kotlin DSL stack:

🧰 Getting Started

🔧 Prerequisites

Java 21

🏃 Run Locally

./gradlew quarkusDev 

📑 Usage

Access the web page in your browser by entering the url

http://localhost:8080/qr-page
  • Home page: enter text and press Enter or click the button home-page.png
  • QR code page: Press the "Download" button to receive the QR code in jpg file format qrcode-page.png
  • About page: accessible by clicking the blinking red light in upper right corner about-page.png

or perform a request in the exposed REST endpoint using the following sample in order to receive the QR code in SVG file format:

curl --request GET --url 'http://localhost:8080/qr/download/svg?text=sample-text'

⚠️ License

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

🤝 Contact

You can reach me at:

About

QuickQR is a lightweight, modern web application that instantly generates QR codes through both a clean web interface and a flexible REST API. Built with Quarkus, Kotlin, and Gradle (Kotlin DSL).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published