Skip to content

Installation

Prerequisites

  • Node.js (LTS recommended)
  • npm

Install dependencies

From the katalyst-vite project root:

bash
npm install

Run locally

bash
npm run dev

Vite will print the local URL (typically http://localhost:5173).

Environment variables

Katalyst reads configuration from import.meta.env and validates it via:

  • src/shared/infrastructure/config/EnvSchema.ts

You can provide overrides using a Vite-supported env file (for example, .env.local).

Common variables:

  • VITE_APP_NAME
  • VITE_APP_ENVIRONMENT (defaults to development)
  • VITE_API_BASE_URL
  • VITE_API_TIMEOUT
  • VITE_AUTH_LOGIN_PATH
  • VITE_AUTH_TOKEN_KEY
  • VITE_AUTH_CURRENT_USER_KEY
  • VITE_USE_MSW (set to true to enable MSW in src/main.tsx)
  • VITE_ENABLE_PUBLIC_CODE_EXAMPLES

If you’re unsure what’s required, use EnvSchema.ts as the source of truth.

Next steps

  • Start with Primitives to understand the shared interaction building blocks.
  • Use Patterns to apply them to real admin UI workflows.