Pihkaal
4a0bd62432
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m12s
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
<div align="center">
|
|
<h1><a target="_blank" href="https://simple-qr.com">simple-qr.com</a></h1>
|
|
<img src="./docs/demo.gif" alt="demo" />
|
|
</div>
|
|
|
|
Simple, bullshit-free QR code generator with straightforward API.
|
|
|
|
## What it does
|
|
|
|
- Generate QR codes via a simple web UI or a straightforward REST API
|
|
- Embed logos (30+ brands: Gitea, Signal, Monero, Session, etc.) in the center of QR codes
|
|
- Export in PNG, JPEG, or WebP formats
|
|
- No authentication, no rate limiting, no ads
|
|
|
|
## Stack
|
|
|
|
- [Nuxt 4](https://nuxt.com) + [Nuxt UI](https://ui.nuxt.com)
|
|
|
|
## API
|
|
|
|
### `GET /api` - Generate a QR code
|
|
|
|
Returns the QR code as an image file.
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|---------------------------|----------|-----------------------------------------------------|
|
|
| `content` | string | yes | Data to encode |
|
|
| `format` | `png` \| `jpeg` \| `webp` | no | Output format (default: `png`) |
|
|
| `logo` | string | no | Logo name to embed in the center (case-insensitive) |
|
|
|
|
**Example:**
|
|
```
|
|
GET https://simple-qr.com/api?content=https://git.pihkaal.me&format=webp&logo=gitea
|
|
```
|
|
|
|
### `GET /api/logos` - List available logos
|
|
|
|
Returns a JSON array of available logo names.
|
|
|
|
**Example:**
|
|
```
|
|
GET https://simple-qr.com/api/logos
|
|
```
|
|
|
|
```json
|
|
["signal", "monero", "session", ...]
|
|
```
|