# 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](https://www.avery.co.uk/product/mini-multipurpose-labels-l4731rev-25), [DE shop](https://www.avery-zweckform.com/produkt/universal-etiketten-l4731rev-25))

### Features

- Generate up to 189 QR code labels in a batch
- Customize start number, prefix, and number formatting
- Adjustable layout options for precise printer alignment:
  - Vertical Offset (mm): shifts the label grid up or down
  - Horizontal Offset (mm): shifts the label grid left or right
  - Label Height (mm): controls the vertical size of each label
  - Content Scale (%): scales QR code and text inside each label
  - Show Border: toggles visible borders to help with calibration
- Print-ready formatting for A4 label sheets

### 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](https://developer.mozilla.org/en-US/docs/Web/CSS/@page) 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](https://tailwindcss.com) and [AlpineJS](https://alpinejs.dev). 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](https://www.baucloud.com).

Special thanks to [Marvin Gaube](https://margau.net) for the insightful blog post ["paperless-ngx with qr codes as ASN: My Workflow"](https://margau.net/posts/2023-04-16-paperless-ngx-asn/). His workflow greatly inspired the development of this application.

Additionally, this project drew inspiration from the CLI tool [paperless-asn-qr-codes](https://git.jcg.re/jcgruenhage/paperless-asn-qr-codes) developed by [Jan Christian Grünhage](https://jcg.re). 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)](https://www.gnu.org/licenses/agpl-3.0.html).

All rights reserved by [Tobias L. Maier](https://tobiasmaier.info).