mirror of https://github.com/tmaier/asn-qr-code-label-generator.git synced 2026-03-14 08:33:37 +00:00

No description

Find a file

ChristofK 7e7e3b3414 Add layout adjustment options: vertical/horizontal offset, label height, and scale. This commit adds several new customization options to improve label alignment and output quality when printing QR code labels: - Introduced vertical and horizontal offset inputs to shift the entire label grid for fine alignment. - Added label height input to adjust the height of each individual label in millimeters. - Added content scale input to resize the entire label content (QR code and text). Also updated the UI to include explanatory text for each of these parameters, and added a summary paragraph to the main instructions describing how each setting affects the layout.		2025-07-16 18:40:02 +02:00
.editorconfig	Add index.html and README	2023-12-27 23:38:26 +01:00
index.html	Add layout adjustment options: vertical/horizontal offset, label height, and scale.	2025-07-16 18:40:02 +02:00
LICENSE	Initial commit	2023-12-27 23:02:33 +01:00
README.md	Elaborate on the limitations in the README	2023-12-28 22:43:57 +01:00

README.md

QR Code Label Generator for ASNs in Paperless-ngx

About the Project

This project is a web-based QR code label generator specifically designed for generating Archive Serial Number (ASN) labels in Paperless-ngx. It's a simple and efficient tool aimed at streamlining the process of creating QR code labels for document management.

A live version of this application can be accessed at https://tobiasmaier.info/asn-qr-code-label-generator/.

Current Status

This application is currently in an early alpha stage and has not been extensively tested. Users are encouraged to validate the output, especially the positioning of the labels.

Supported label formats

The application currently supports the following label formats:

Avery L4731REV-25 (See UK shop, DE shop)

Limitations

The application currently has the following limitations:

The application is currently only available in English. This is considered a non-issue, as the application is designed to be self-explanatory.
The application currently only supports the Avery L4731REV-25 label format. Contributions for additional label formats are welcome.
The application only supports Google Chrome and Chromium-based browsers, such as Microsoft Edge. And partially Firefox. This limitation is due to the use of the CSS @page rule for printing. Contributions for additional browser support are welcome.

Key Design Decisions

Browser-Based Application: The application is designed to run entirely on the client side, avoiding the need for server-side logic. This approach simplifies deployment and reduces hosting requirements.
Simple Technology Stack: The application is built using TailwindCSS and AlpineJS. TailwindCSS provides utility-first CSS classes for styling, while AlpineJS offers reactive and declarative JavaScript for handling interactivity. This combination results in a comparatively lightweight and maintainable codebase.

Contributions

Contributions to this project are welcome. If you have ideas for improvements or have found bugs, please feel free to contribute. You can submit your contributions via GitHub at https://github.com/tmaier/asn-qr-code-label-generator.

Acknowledgments

This project has been made possible with the support and sponsorship of BauCloud GmbH.

Special thanks to Marvin Gaube for the insightful blog post "paperless-ngx with qr codes as ASN: My Workflow". His workflow greatly inspired the development of this application.

Additionally, this project drew inspiration from the CLI tool paperless-asn-qr-codes developed by Jan Christian Grünhage. His work follows the same goal of streamlining the process of creating ASN labels for paperless-ng, but uses a different approach.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).