https://github.com/alexkolodko/yourls-local-qr-code

YOURLS Local QR Code in SVG, PDF & Image Plugin
https://github.com/alexkolodko/yourls-local-qr-code

Last synced: 14 days ago
JSON representation

YOURLS Local QR Code in SVG, PDF & Image Plugin

• Host: GitHub
• URL: https://github.com/alexkolodko/yourls-local-qr-code
• Owner: alexkolodko
• License: mit
• Created: 2024-01-19T21:06:16.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-01-27T11:57:13.000Z (10 months ago)
• Last Synced: 2024-08-02T06:16:52.521Z (4 months ago)
• Language: JavaScript
• Size: 194 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - QRCode Local

README

        
# YOURLS Local QR Code in SVG, PDF & Image Plugin

Allows you to get the QR code by by adding `.qr` to the end of the short URL. 

## Installation

1. Move the `qr` folder into the root folder. The interface for displaying QR codes will be at `YOURLS_SITE/qr` 

1. Move the `qr-code-svg-local` folder into the `/users/plugins` folder. Then, activate the plugin in the admin interface.

1. Go to the Plugins Administration page and activate the plugin.

1. Have fun! 🤖

## QR Parameters

You can also use the parameters to generate QR codes via url.

List of options (same with `qrcode-svg` library):

* content - QR Code content (yourls short link), the only **required** parameter

* padding - white space padding, default: `0` modules, `4` for classic use

* width - QR Code width in pixels, default: `256 px`

* height - QR Code height in pixels, default:  `256 px`

* color - color of modules (squares), color name or hex string (without hash # symbol), e.g. FF0000, default: `000000`

* background - color of background, color name or hex string, e.g. white, default: `none` 

* ecl - error correction level: L, M, H, Q. Default: `М`

* xmlDeclaration - prepend XML declaration to the SVG document, i.e. ``, default: `false`

## Dependecies

Main functionality of adding a QR code is borrowed from Ozh's orginal plugin code.

QR code generation and convert made possible by

* [qrcode-svg](https://github.com/papnkukn/qrcode-svg)

* [jsPDF](https://github.com/parallax/jsPDF)

* [svg2pdf](https://github.com/yWorks/svg2pdf.js)

* [html2canvas](https://html2canvas.hertzen.com/)

## Legal notice

```

Licensed under the MIT license:

http://www.opensource.org/licenses/mit-license.php

The word "QR Code" is registered trademark of DENSO WAVE INCORPORATED

http://www.denso-wave.com/qrcode/faqpatent-e.html

```