External/joulenap
1
0
Fork 0
mirror of https://github.com/Joulenap/joulenap.git synced 2026-08-11 13:21:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: explain how to run the frontend against the dev stub

Browse Source
This commit is contained in:
Catubba
2026-07-09 23:45:54 +02:00
parent a0cfa0feb4
commit 9691db586f
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+18
View File
@@ -48,6 +48,24 @@ cd backend && python -m app.main # serves the API (and the built SPA if you r
The example config ships **unconfigured**, so the app drops you into the first-run registration and
setup wizard — no real Proxmox needed to click around the UI.
### Frontend without a backend
To work on the UI alone — layout, styling, i18n — you can run the SPA against a built-in
stub instead of a real backend and a real Proxmox:
```bash
cd frontend
npm run dev -- --mode stub
```
`frontend/src/devStub.ts` answers every `/api/*` request from fixtures (a configured install,
three guests, a few log lines) and pins the clock, so the UI renders exactly the same on every
run — handy for screenshots and layout comparisons. It is loaded only when `VITE_STUB_API=1`,
which `frontend/.env.stub` sets for the `stub` mode, and Vite eliminates it from production
builds.
Add `--host 0.0.0.0` to reach the dev server from a phone on the same network.
## Before you open a PR
Run what CI runs (see [`.github/workflows/ci.yml`](.github/workflows/ci.yml)); all of it must pass: