Skip to content

armgit / bygga

Public Imported from GitHub
0

IKEA assembly, step by step: animated, manual-style 3D guides. Scan any paper manual with Together AI.

TypeScript

The repo lives at Nutlope/bygga; a tighter README without the security section

Hassan El Mgharif2b321ef43ad
diff --git a/.env.example b/.env.example
index e5c298c..47b3ce4 100644
--- a/.env.example
+++ b/.env.example
@@ -6,7 +6,7 @@
TOGETHER_API_KEY=
# Optional: the GitHub repo shown (with its star count) in the nav.
-# NEXT_PUBLIC_GITHUB_REPO=Luffixos/bygga
+# NEXT_PUBLIC_GITHUB_REPO=Nutlope/bygga
# Optional: comma separated model lists, tried in order.
# TOGETHER_TEXT_MODEL=openai/gpt-oss-120b,zai-org/GLM-5.3-Flash,Qwen/Qwen3.8-Flash
diff --git a/README.md b/README.md
index 2e5eff2..2d6d720 100644
--- a/README.md
+++ b/README.md
@@ -10,18 +10,18 @@
- Next.js 16 (App Router, Cache Components), React 19 and TypeScript, plain CSS with Motion, no UI kit
- A three.js line-art stage (`src/engine`) and a parametric plan generator (`src/lib/plan`) that draw 1,171 IKEA products (2,180 sizes, UK and US ranges) offline, built from IKEA's public listings (`scripts/ikea`)
-- A hands-free voice: 1,476 pre-recorded Kokoro clips that play with no key, and "next" heard through an echo-cancelled mic and Whisper on Together (`/api/listen`, `hearIntent` in `src/lib/voice/commands.ts`)
+- A hands-free voice: 1,476 pre-recorded Kokoro clips that play with no key, and Whisper on Together listening for "next" through an echo-cancelled mic (`/api/listen`, `hearIntent` in `src/lib/voice/commands.ts`)
- Together AI on each visitor's own key (`src/components/KeyModal.tsx`): drafts for products we don't have, photo lookup, and a help chat that answers with drawings of the exact panel, fitting or step
- Share cards drawn by the same engine (`scripts/og/render.mjs`), an A4 print view, and a service worker so opened guides work with no signal
-- Checks: `npm run voice:check` replays 283 recorded listening runs, `npm run ikea:check` tests every catalog row
+- Tests: `npm run voice:check` replays 283 recorded listening runs, and `npm run ikea:check` tests every catalog row
## Cloning & running
-1. Clone: `git clone https://github.com/Luffixos/bygga.git && cd bygga && npm install`
+1. Clone: `git clone https://github.com/Nutlope/bygga.git && cd bygga && npm install`
2. Run: `npm run dev`, open http://localhost:3000 and type `BISSA`
3. Jump to a step: http://localhost:3000/build/malm-3-drawers?step=12, or print the guide at `/build/malm-3-drawers/print`
4. See every build you've finished, side by side at true scale: http://localhost:3000/builds
-5. Try the AI parts: `cp .env.example .env.local`, set `TOGETHER_API_KEY`, then paste `bygga-dev-mock-key-000000` into the app's key box (only `npm run dev` accepts it, and it stands for your key)
+5. Try the AI parts: `cp .env.example .env.local`, set `TOGETHER_API_KEY`, then paste `bygga-dev-mock-key-000000` into the app's key box. The server swaps in your `TOGETHER_API_KEY`, and only `npm run dev` accepts the mock key.
6. Replay the listening tests after touching the voice: `npm run voice:check`
7. Rebuild the catalog when IKEA's listings change: `npm run ikea:fetch && npm run ikea:build && npm run ikea:check`
8. Before pushing: `npm run lint && npm run build`
@@ -31,10 +31,8 @@
- [ ] teach the generator the last odd shapes in `scripts/ikea/skips.ts`: three-cornered shelves, corner combinations, PAX widths that don't split into frames
- [ ] give the voice more languages than English
- [ ] test the manual scanner (`NEXT_PUBLIC_SCAN=1`) on a stack of real manuals and bring it back
-- Mirroring IKEA's PDF manuals is skipped on purpose: every guide is generated, and each cover links to the official manual on ikea.com.
+- We don't mirror IKEA's PDF manuals, on purpose. Every guide is generated, and each cover links to the official manual on ikea.com.
-## Security
+## License
-The site has no Together key of its own in production: every AI call runs on the visitor's key, which stays in their `localStorage`, travels only in an `x-together-key` header, and is never stored or logged. Every `/api/*` route answers only the site's own pages and is rate limited per IP, the pages send a strict Content Security Policy, and [/privacy](https://www.usebygga.com/privacy) lists what goes where.
-
-MIT licensed, see [LICENSE](LICENSE). Bygga is not affiliated with IKEA: IKEA and its product names are trademarks of Inter IKEA Systems B.V., and the license grants no rights in them (see [NOTICE](NOTICE)).
+MIT, see [LICENSE](LICENSE). Bygga is not affiliated with IKEA: IKEA and its product names are trademarks of Inter IKEA Systems B.V., and the license grants no rights in them (see [NOTICE](NOTICE)).
diff --git a/src/lib/site.ts b/src/lib/site.ts
index 3a18cff..055b8f9 100644
--- a/src/lib/site.ts
+++ b/src/lib/site.ts
@@ -1,4 +1,4 @@
-export const GITHUB_REPO = process.env.NEXT_PUBLIC_GITHUB_REPO ?? "Luffixos/bygga";
+export const GITHUB_REPO = process.env.NEXT_PUBLIC_GITHUB_REPO ?? "Nutlope/bygga";
export const GITHUB_URL = `https://github.com/${GITHUB_REPO}`;
/** Where the site lives, for share cards, the sitemap and absolute links. */