Appearance
Getting started
KPZ is a Nuxt 4 application built with Vue 3 and TypeScript. It uses Pinia for state, Tailwind CSS 4 and Reka UI for the interface, and Nuxt server routes to communicate with the backend.
Requirements
- Node.js 22 and pnpm 11, matching the CI configuration.
- Access to the KPZ backend to use authenticated application features.
Install and configure
From the repository root:
sh
pnpm install
cp .env.example .envIf you already have a .env, keep your existing values. Configure these settings for local development:
| Variable | Purpose | Local value |
|---|---|---|
NUXT_API_BASE | Backend address used by the Nuxt server | http://localhost:8000 |
NUXT_PUBLIC_APP_URL | Frontend application URL | http://localhost:3000 |
NUXT_PUBLIC_DEFAULT_LOCALE | Interface language (en or nl) | The example file uses en |
NUXT_PUBLIC_SENTRY_ENABLED | Enable Sentry integration | false |
Sentry settings are listed in .env.example. They are not needed for ordinary local development. Keep credentials in your local environment, never in documentation.
Run the application
sh
pnpm devOpen http://localhost:3000. Run the backend at the address configured above for API-dependent pages and login.
Run this documentation site
sh
pnpm docs:devOpen http://localhost:5173/docs/. The docs run independently of Nuxt and do not require a backend or .env configuration. Edits to documentation appear immediately in the browser.
Next, read the architecture guide or browse the UI component reference.