Skip to content

Commit 32cb513

Browse files
committed
docs: regenerate screenshots and GIF with new branding and demo mode
- All screenshots and demo GIF now show "LLM API Bench" branding - Demo mode properly activated via frontend/.env.local - record-demo.sh --dev now sets VITE_DEMO_MODE=true for vite - Updated CLAUDE.md with reliable demo mode setup instructions
1 parent 36df03d commit 32cb513

9 files changed

Lines changed: 9 additions & 5 deletions

CLAUDE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@ Key routing rules:
2222

2323
- All screenshots in `docs/screenshots/` must be **1100×720** pixels
2424
- Use puppeteer with `defaultViewport: { width: 1100, height: 720 }`
25-
- Always run the dev server in **Demo Mode** before capturing screenshots so Provider names, endpoints, and API keys are sanitized:
25+
- Always run the dev server in **Demo Mode** before capturing screenshots or recording GIFs so Provider names, endpoints, and API keys are sanitized.
26+
- **Preferred method**: create `frontend/.env.local` with `VITE_DEMO_MODE=true` — Vite picks this up reliably. Inline env vars (`VITE_DEMO_MODE=true npx vite`) may not propagate in all shell contexts.
2627
```bash
27-
cd frontend && VITE_DEMO_MODE=true npm run dev
28+
echo "VITE_DEMO_MODE=true" > frontend/.env.local
29+
cd frontend && npm run dev
2830
```
29-
Demo Mode rewrites display values only (no DB writes). Mapping: id-stable `ProviderA/B/C…`, `https://api.provider-a.example.com/v1`, `sk-****`. Implementation: `frontend/src/utils/demo.ts`.
31+
- `record-demo.sh --dev` starts its own Vite server — it reads `frontend/.env.local` automatically. When using `--skip-server`, ensure the external Vite server was started with demo mode.
32+
- Demo Mode rewrites display values only (no DB writes). Mapping: id-stable `ProviderA/B/C…`, `https://api.provider-a.example.com/v1`, `sk-****`. Implementation: `frontend/src/utils/demo.ts`.
33+
- **Do NOT commit** `frontend/.env.local` — it is in `.gitignore`.
3034

3135
## GitHub Rules
3236

docs/demo.gif

-108 KB
Loading
53 Bytes
Loading
165 Bytes
Loading
-7.02 KB
Loading
178 Bytes
Loading
290 Bytes
Loading
94 Bytes
Loading

scripts/record-demo.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ if [ "$SKIP_SERVER" = false ]; then
6464
PORT="$BACKEND_PORT" npx tsx src/index.ts > /dev/null 2>&1 &
6565
PIDS+=($!)
6666

67-
echo "🚀 Starting frontend (dev)..."
67+
echo "🚀 Starting frontend (dev, demo mode)..."
6868
cd "${ROOT}/frontend" && npm install --silent 2>/dev/null
69-
npx vite --port "$FRONTEND_PORT" > /dev/null 2>&1 &
69+
VITE_DEMO_MODE=true npx vite --port "$FRONTEND_PORT" > /dev/null 2>&1 &
7070
PIDS+=($!)
7171
else
7272
# Production mode: build everything

0 commit comments

Comments
 (0)