Getting Started

Use these guides to move from installation to production runtime without bouncing between framework pages, demos, and reference docs.

Install and Wire It

Start with the plugin, the bridge file, path configuration, and the assets CLI.

Install and Configure

Development Workflow

Keep HMR, proxy mode, direct mode, and manual dev-server workflows on one page.

Development Workflow

Choose a Runtime Mode

Pick SPA, template, hybrid, or framework proxy mode based on how much frontend runtime you want.

Operation Modes

Generate Types

Export OpenAPI, routes, and Inertia page props into frontend-friendly TypeScript outputs.

Type Generation

Production and Deploy

Build assets, publish them, and hand manifest-backed bundles back to Litestar cleanly.

Production and Deploy

Quick Start

app.py

from pathlib import Path

from litestar import Litestar
from litestar_vite import PathConfig, ViteConfig, VitePlugin

app = Litestar(
    plugins=[
        VitePlugin(
            config=ViteConfig(
                dev_mode=True,
                paths=PathConfig(root=Path(__file__).parent),
            )
        )
    ]
)

bootstrap a frontend

litestar assets init --template react-inertia
litestar assets install
litestar run --reload