docs: add README with stack overview and Coolify deploy steps
This commit is contained in:
36
README.md
Normal file
36
README.md
Normal file
@@ -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.
|
||||||
Reference in New Issue
Block a user