Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sayanarijit/qrcode.show

[WORKING PROTOTYPE] Generate QR code easily for free - QR Code Generation as a Service
https://github.com/sayanarijit/qrcode.show

qr qr-code qrcode qrcode-generator rust terminal webapp

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/sayanarijit/qrcode.show
Owner: sayanarijit
License: agpl-3.0
Created: 2021-09-13T08:38:02.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-01-15T08:41:35.000Z (over 1 year ago)
Last Synced: 2024-03-25T15:33:44.273Z (3 months ago)
Topics: qr, qr-code, qrcode, qrcode-generator, rust, terminal, webapp
Language: Rust
Homepage: https://QRcode.show
Size: 1.13 MB
Stars: 596
Watchers: 9
Forks: 32
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Lists

awesome - sayanarijit/qrcode.show - [WORKING PROTOTYPE] Generate QR code easily for free - QR Code Generation as a Service (Rust)

README

QRcode.show

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

### INPUT:

```bash
curl qrcode.show/INPUT
```

```bash
curl qrcode.show -d INPUT
```

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

```bash
echo INPUT | curl qrcode.show -d @-
```

### INPUT EXAMPLES:

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

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

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

```bash
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:

```bash
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`

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

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

```bash
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](./examples/nodejs)

### 🚀 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