8000
Skip to content < 7FFF span data-view-component="true" class="progress-pjax-loader Progress position-fixed width-full">

Latest commit

 

History

History

README.md

Joulenap frontend

React + TypeScript + Vite SPA for Joulenap, wired to the backend REST API.

Develop

cd frontend
npm ci
npm run dev        # Vite dev server on :5173, proxies /api -> http://localhost:8080

Run the backend (cd backend && joulenap or uvicorn app.main:create_app --factory) alongside it so the proxied API is available.

Build

npm run build      # type-checks (tsc --noEmit) then emits frontend/dist

The FastAPI backend serves frontend/dist as static files, so a production image just needs the built output present. dist/ is git-ignored.

Layout

  • src/api/ — typed client + response types for /api/*
  • src/auth/, src/config/ — auth + config React contexts
  • src/pages/Login, Dashboard (+ dashboard/ panels), Settings (+ settings/ panels, incl. the device editor)
  • src/wizard/ — the two device wizards (add a PVE, add a PBS) and the PBS steps they share
  • src/shell/ — header + authenticated app shell
  • src/components/, src/hooks/, src/utils/ — shared widgets/helpers
  • src/i18n/react-i18next setup; en.json is the base language, it.json the translation

i18n

English is the source language. The active language follows app.language from the backend config (the Localization settings panel changes it). Add a key to en.json first, then mirror it in it.json.

0