diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..f84a790 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 +indent_style = space +indent_size = 2 diff --git a/README.md b/README.md new file mode 100644 index 0000000..713aed3 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# 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 . + +### 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)) + +### Limitations + +The application currently has the following limitations: + +- The application is currently only available in English. +- The application currently only supports the Avery L4731REV-25 label format. +- 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. + +### 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 . + +## 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). diff --git a/index.html b/index.html new file mode 100644 index 0000000..19bdadd --- /dev/null +++ b/index.html @@ -0,0 +1,269 @@ + + + + + + QR Code Label Generator for ASN in Paperless-ngx + + + + + + +
+

+ QR Code Label Generator for + ASN in Paperless-ngx +

+
+

+ This tool generates QR code labels for the + Archive Serial Number (ASN) + feature in + Paperless-ngx. +

+ +

+ The ASN feature allows you + to assign a unique serial number to each document in your archive. + This is useful if you want to refer to a document in a paperless + workflow. For example, you can print the + ASN + on a document and then use it to search for the document in + Paperless-ngx. +

+ +

+ This tool generates QR code labels for the + ASN feature. You can + generate labels for up to 189 documents at once. The labels are + formatted to fit on Avery L4731REV-25 labels. +

+ +

+ To use this tool, enter the start number, prefix, and number of + leading zeros. Then click the "Regenerate Labels" button. The labels + will be generated and displayed below. You can then print the labels + by clicking the "Print Labels" button. +

+
+
+ +
+
+ + +
+

+ The number of labels generated will be 7 x 27 = 189. This means + the next batch of labels should + start with + 190. +

+
+
+
+ + +
+

+ If you change this, update the prefix in + Paperless-ngx accordingly via + PAPERLESS_CONSUMER_ASN_BARCODE_PREFIX. +

+
+
+
+ + +
+
+
+
+ +
+ +
+
+

+ This may be useful for debugging or to calibrate the print out. +

+
+
+
+ + +
+
+ +
+ +
    + +
+
+ + + + + +