sayanarijit / qrcode.show Goto Github PK

View Code? Open in Web Editor NEW

596.0 9.0 32.0 1.16 MB

[WORKING PROTOTYPE] Generate QR code easily for free - QR Code Generation as a Service

Home Page: https://QRcode.show

License: GNU Affero General Public License v3.0

Rust 78.03% HTML 21.87% Procfile 0.10%

qrcode qrcode-generator qr-code qr rust webapp terminal

qrcode.show's Introduction

QRcode.show

Generate QR code easily for free - QR Code Generation as a Service.

INPUT:

curl qrcode.show/INPUT

curl qrcode.show -d INPUT

curl qrcode.show -d @/PATH/TO/INPUT

echo INPUT | curl qrcode.show -d @-

INPUT EXAMPLES:

curl qrcode.show/https://example.com

curl qrcode.show -d https://example.com

curl qrcode.show -d @/path/to/input.txt

echo https://example.com | curl qrcode.show -d @-

PARAMETERS:

    Accept                      Specify the output type
                                Options:
                                    application/octet-stream
                                    text/plain
                                    text/html
                                    image/svg+xml
                                    image/png
                                    image/jpeg
                                Default: application/octet-stream

    X-QR-Width                  Specify the default width

    X-QR-Height                 Specify the default height

    X-QR-Min-Width              Specify the minimum width

    X-QR-Min-Height             Specify the minimun height

    X-QR-Max-Width              Specify the maximum width

    X-QR-Max-Height             Specify the maximum height

    X-QR-Dark-Color             Specify the dark color (hex)
                                Format: rrggbb

    X-QR-Light-Color            Specify the light color (hex)
                                Format: rrggbb

    X-QR-Version-Type           Specify the QR version type
                                Options:
                                    normal
                                    micro
                                Default: auto detect

    X-QR-Version-Number         Specify the QR version number
                                Options:
                                    1..40 for normal
                                    1..4 for micro
                                Default: auto detect

    X-QR-EC-Level               Specify the error checking level
                                Options:
                                    L
                                    M
                                    Q
                                    H
                                Default: L

    X-QR-Quiet-Zone             Specify whether the quiet zone is added
                                Options:
                                    true
                                    false
                                Default: true

PARAMETER EXAMPLES:

curl qrcode.show/INPUT -H "Accept: image/svg+xml"

SHELL FUNCTIONS:

Shell functions that can be added to .bashrc or .bash_profle for quickly generating QR codes from the command line. The command takes the argument as input or reads from stdin if none was supplied and outputs the QR code to stdout: qrcode INPUT or echo INPUT | qrcode

qrcode () {
  local input="$*"
  [ -z "$input" ] && local input="@/dev/stdin"
  curl -d "$input" https://qrcode.show
}

qrsvg () {
  local input="$*"
  [ -z "$input" ] && local input="@/dev/stdin"
  curl -d "${input}" https://qrcode.show -H "Accept: image/svg+xml"
}

qrserve () {
  local port=${1:-8080}
  local dir=${2:-.}
  local ip="$(ifconfig | grep -Eo '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}' | fzf --prompt IP:)" \
    && echo http://$ip:$port | qrcode \
    && python -m http.server $port -b $ip -d $dir
}

PROGRAMMING LANGUANGE EXAMPLES

Node.js

🚀 FEATURES :

No data collection or retention
Fast and simple API that works on both web and terminal
Supports GET and POST requests
Supports Accept header to control the output format

📝 TODO:

Support more parameters
Get a logo
Support dynamic QR codes
Generate premium/branded QR codes

💖 SPONSORS:

Nolan Rumble - https://nolanrumble.com - $5

Top 5 sponsors get mentioned here (updated monthly) Visit https://opencollective.com/qrcodeshow

📋 CREDITS:

Main Library https://github.com/kennytm/qrcode-rust
Cloudflare Worker https://github.com/cloudflare/workers-rs
Alternate Web Server https://github.com/tokio-rs/axum

Only the direct dependencies for the main business logic are listed here. Please contact the project maintainer if you are missing from the list.

🔗 RELATED LINKS:

Project Repository https://github.com/sayanarijit/qrcode.show
Project Maintainer https://arijitbasu.in

📓 COPYRIGHT:

© Arijit Basu 2021

qrcode.show's People

Contributors

Stargazers

Watchers

qrcode.show's Issues

QR code generated in terminal is not readable due to dark background color.

Describe the bug

Unable to read QR code generated in terminal because of dark background color of terminal. But works fine when background color is changed to white.

Add a QR code resolution parameter

Describe the solution you'd like
A resolution parameter to choose how big the QR code is (e.g. Google Chart's chs)

Additional context
Just add some simple parameter such as res=<width>x<height> or something. I dunno ¯_(ツ)_/¯

Document in Markdown

We Can Make this project, README in markdown with code snippets, headers, images, & more.

CORS Missing Allow Origin

Anyway you could allow any origin so that QR code could be generated client side in the browser?
Access-Control-Allow-Origin: *

I'm getting failed network requests when trying to do this in the browser. See example here: https://codesandbox.io/s/qrcode-test-gqktd?file=/src/App.vue

Thanks!

Format QR code type

Hello
Can you make some QR style?
like this

beautify the homepage

-i can work on beautifying the homepage by creating a sticky navbar.
-make it mobile friendly.
also any changes you'd like you can suggest.

error getting canonical path to source HTML file "index.html

hi When using trunk on Windows, When using trunk on Windows

Add more web frontend functionalities

Is your feature request related to a problem? Please describe.

We can pass many parametets from the command-line using http headers. But the web frontend is still lacking in functionalities. It can only generate SVG images and print the PDF, which is rather limited.

Describe the solution you'd like

Add a minimized "Advanced" button, clicking which we get more options. Options like download png/jpeg, set dimensions etc.

Describe alternatives you've considered

None

Additional context

The UI needs to be simple and easy to use. By default, users shouldn't be able to see all the buttons. Only by clicking the "Advanced" button, all the customisation options should appear.
Also, we need to keep the website lightweight. Let's avoid using external libraries as much as possible.

Qrcode.show Logo

Is your feature request related to a problem? Please describe.
A logo is required for the product

Describe the solution you'd like
I would like to try and design a logo for this.