diff --git a/README.md b/README.md new file mode 100644 index 0000000..b36fc5a --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# QR Code Studio + +Browser app to generate styled QR codes from a URL with a center logo, custom +body (dot) style, custom corner edges, and adjustable logo padding. + +## Stack + +- Vue 3 + Vite + TypeScript +- [`qr-code-styling`](https://github.com/kozakdenys/qr-code-styling) for rendering + +## Development + +```bash +npm install +npm run dev +``` + +## Production build + +```bash +npm run build +npm run preview +``` + +## Deploy to Coolify + +The repo ships a multi-stage `Dockerfile` (Node build → nginx serve) and an +`nginx.conf`. In Coolify: + +1. Create a new resource → **Application** → **Dockerfile** (or Git-based). +2. Point it at this repository / branch. +3. Coolify auto-detects the `Dockerfile`. Container exposes port **80**. +4. Set a domain in Coolify — it handles TLS via Traefik/Caddy. +5. Deploy. + +No environment variables are required; the app is fully client-side.