README.md added

2026-06-03 08:56:44 -07:00
parent 7ee48a2785
commit 0b42814151
1 changed files with 38 additions and 41 deletions
@@ -1,46 +1,43 @@
-# Astro Starter Kit: Basics
+# GenQBar

-```sh
-npm create astro@latest -- --template basics
+Client-side QR code and barcode generator. No server, no tracking, no data leaves your browser.
+
+Part of [BugLabs.dev](https://buglabs.dev).
+
+## Features
+
+- **QR codes** — any text or URL, with selectable error correction (L/M/Q/H) and size (128/256/512px)
+- **Barcodes** — CODE128, CODE39, EAN-13, EAN-8, UPC-A; optional value display
+- **SVG download** — clean vector output, ready for print or web
+- **Live preview** — generates as you type, 300ms debounce
+- **No dependencies at runtime** — pure client-side, Astro static output
+
+## Stack
+
+- [Astro 6](https://astro.build) — static site generator
+- [qrcode](https://github.com/soldair/node-qrcode) — QR code SVG generation
+- [JsBarcode](https://github.com/lindell/JsBarcode) — barcode SVG generation
+- Vanilla JS, Space Grotesk + Space Mono fonts, no UI framework
+
+## Project Structure
+
+```
+src/
+├── layouts/
+│   └── Layout.astro      # HTML shell, Google Fonts
+├── pages/
+│   └── index.astro       # Generator page + client JS
+└── styles/
+    └── app.css           # Design system (BugLabs.dev tokens)
 ```

-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+## Commands

-## 🚀 Project Structure
+| Command           | Action                                      |
+| :---------------- | :------------------------------------------ |
+| `npm install`     | Install dependencies                        |
+| `npm run dev`     | Dev server at `localhost:4321`              |
+| `npm run build`   | Production build to `./dist/`               |
+| `npm run preview` | Preview production build locally            |

-Inside of your Astro project, you'll see the following folders and files:
-
-```text
-/
-├── public/
-│   └── favicon.svg
-├── src
-│   ├── assets
-│   │   └── astro.svg
-│   ├── components
-│   │   └── Welcome.astro
-│   ├── layouts
-│   │   └── Layout.astro
-│   └── pages
-│       └── index.astro
-└── package.json
-```
-
-To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).
-
-## 🧞 Commands
-
-All commands are run from the root of the project, from a terminal:
-
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `npm install`             | Installs dependencies                            |
-| `npm run dev`             | Starts local dev server at `localhost:4321`      |
-| `npm run build`           | Build your production site to `./dist/`          |
-| `npm run preview`         | Preview your build locally, before deploying     |
-| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI                     |
-
-## 👀 Want to learn more?
-
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+Requires Node >= 22.12.0.