Skip to content

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

License

Notifications You must be signed in to change notification settings

vitabef/qrcode.show

 
 

Repository files navigation

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
                                    image/svg+xml
                                    text/html
                                Default: application/octet-stream

    X-QR-Min-Width              Specify the minimum width

    X-QR-Min-Height             Specify the minimun 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

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 a
    filename or reads from stdin if none was supplied and outputs the QR code
    to stdout: `qrcode /PATH/TO/INPUT` or `echo INPUT | qrcode`

        qrcode () {
          local file=${1:-/dev/stdin}
          curl -d @${file} https://qrcode.show
        }

        qrsvg () {
          local file=${1:-/dev/stdin}
          curl -d @${file} https://qrcode.show -H "Accept: image/svg+xml"
        }

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:
    
    * Download JPEG, PNG support
    * Support more parameters
    * Get a logo
    * Support dynamic QR codes
    * Generate premium/branded QR codes

SPONSORS:

    Top 5 sponsors get mentioned here

CREDITS:

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

    *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:

    Alternate Domain            https://qrqr.show

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

    Donate & Support            https://ko-fi.com/sayanarijit
                                https://liberapay.com/sayanarijit

COPYRIGHT:

    © Arijit Basu 2021

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 71.7%
  • HTML 28.3%