Litestar Vite
Litestar Vite connects the Litestar backend to a Vite toolchain. It supports SPA, Template, Inertia, and meta-framework workflows, and it can proxy Vite dev traffic through your ASGI port or run Vite directly.
Features
- One-port dev: proxies Vite HTTP + WS/HMR through Litestar on a single ASGI port by default.
- Framework-mode support: use
mode="framework"(aliasmode="ssr") for Astro, Nuxt, and SvelteKit. Litestar proxies everything except your API routes. - Production assets: reads the Vite manifest from
public/manifest.json(configurable) and serves underasset_url. - Type-safe frontends: optional OpenAPI/routes export plus
@hey-api/openapi-tsvia the Vite plugin. - Inertia support: Inertia v2/v3 protocol support with session middleware, script-element bootstrap by default, and optional SSR.
Install
pip install litestar-vite
npm install litestar-vite-plugin
Quick Start
import os
from pathlib import Path
from litestar import Litestar
from litestar_vite import PathConfig, ViteConfig, VitePlugin
DEV_MODE = os.getenv("VITE_DEV_MODE", "true").lower() in ("true", "1", "yes")
app = Litestar(
plugins=[VitePlugin(config=ViteConfig(
dev_mode=DEV_MODE,
paths=PathConfig(root=Path(__file__).parent),
))]
)
litestar assets init --template vue
litestar assets install
litestar run --reload
Documentation
- Usage Guide: Core concepts, configuration, and type generation.
- Inertia: Fullstack protocols and SSR.
- Frameworks: Guides for React, Vue, Svelte, Angular, Astro, and Nuxt.
- Reference: API and CLI documentation.
For a full list of changes, see the Changelog.
Common Commands
litestar assets init --template <name>: scaffold a frontend or framework applitestar assets install: install frontend dependencies with the configured executorlitestar assets build: build production assetslitestar assets serve: run the frontend toolchain directlylitestar assets generate-types: export OpenAPI, routes, and Inertia page-prop metadatalitestar assets doctor: inspect and optionally repair config drift
Development
# Install Python, docs, and JS dependencies; build package artifacts
make install && make build
# Run an example app
uv run litestar --app-dir examples/vue-inertia assets install
uv run litestar --app-dir examples/vue-inertia run
Replace vue-inertia with any other example app: vue, react, svelte, react-inertia, htmx, angular, astro, nuxt, or sveltekit.
litestar-vite now defaults Inertia apps to script-element bootstrap. Inertia v3 clients use that transport automatically; if you pin Inertia v2, keep createInertiaApp({ defaults: { future: { useScriptElementForInitialPage: true } } }) aligned in the browser entry and SSR entry when ssr=True is enabled, or opt back into the legacy data-page path with InertiaConfig(use_script_element=False).
Links
- Docs: https://litestar-org.github.io/litestar-vite/
- Examples:
examples/(React, Vue, Svelte, HTMX, Inertia, Astro, Nuxt, SvelteKit, Angular) - Real-world example: litestar-fullstack
- Issues: https://github.com/litestar-org/litestar-vite/issues/
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file litestar_vite-0.26.1.tar.gz.
File metadata
- Download URL: litestar_vite-0.26.1.tar.gz
- Upload date:
- Size: 538.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8e5ca58b09e49f4665f8805fb11585d426b64222f81e8574efb592f2c75ba85
|
|
| MD5 |
9b92ee12f07f6378c04b5f021183dd28
|
|
| BLAKE2b-256 |
3682a9d3e3fe8bea963c22597ddbe8b746e7400071a2ca5d890f4e1ffe231d40
|
Provenance
The following attestation bundles were made for litestar_vite-0.26.1.tar.gz:
Publisher:
publish.yml on litestar-org/litestar-vite
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
litestar_vite-0.26.1.tar.gz -
Subject digest:
e8e5ca58b09e49f4665f8805fb11585d426b64222f81e8574efb592f2c75ba85 - Sigstore transparency entry: 2088961478
- Sigstore integration time:
-
Permalink:
litestar-org/litestar-vite@f3cca09dba004891ec01d8ed8e34f01afaee4c32 -
Branch / Tag:
refs/tags/v0.26.1 - Owner: https://github.com/litestar-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f3cca09dba004891ec01d8ed8e34f01afaee4c32 -
Trigger Event:
release
-
Statement type:
File details
Details for the file litestar_vite-0.26.1-py3-none-any.whl.
File metadata
- Download URL: litestar_vite-0.26.1-py3-none-any.whl
- Upload date:
- Size: 279.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a28ddfb250283150f23354458626867bb86335025b5117cd8eced058a6a49955
|
|
| MD5 |
8736dc5dcc06d0b2047401c96b61f36a
|
|
| BLAKE2b-256 |
0db1cc7b3541aa21af32f5f73746b42919894ace08818c23dd1de512a3288ffe
|
Provenance
The following attestation bundles were made for litestar_vite-0.26.1-py3-none-any.whl:
Publisher:
publish.yml on litestar-org/litestar-vite
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
litestar_vite-0.26.1-py3-none-any.whl -
Subject digest:
a28ddfb250283150f23354458626867bb86335025b5117cd8eced058a6a49955 - Sigstore transparency entry: 2088961726
- Sigstore integration time:
-
Permalink:
litestar-org/litestar-vite@f3cca09dba004891ec01d8ed8e34f01afaee4c32 -
Branch / Tag:
refs/tags/v0.26.1 - Owner: https://github.com/litestar-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f3cca09dba004891ec01d8ed8e34f01afaee4c32 -
Trigger Event:
release
-
Statement type:
