README.md

Litestar Start

Interactive CLI to scaffold fullstack Litestar projects with modular choices.

Features

• Interactive prompts — guided setup with questionary
• Database support — PostgreSQL, MySQL, or SQLite via AdvancedAlchemy
• Memory stores — Redis or Valkey for caching / background tasks
• Plugin system — modular plugins that add functionality:
  • AdvancedAlchemy — SQLAlchemy ORM integration with models, services, and dependencies
  • Litestar SAQ — background task queue powered by SAQ (requires a memory store)
  • Litestar Vite — frontend asset bundling with Vite
  • Litestar Granian — high-performance Granian ASGI server
• Docker — optional Dockerfile and docker-compose.infra.yml for local development
• Post-generation setup — automatic git init, uv sync, Docker infrastructure startup, and import sorting

Requirements

• Python 3.13+
• uv (used for dependency management in generated projects)

Installation

uvx litestar-start

Or install globally:

uv tool install litestar-start

Usage

Run the CLI and follow the interactive prompts:

litestar-start

You will be asked to:

1. Enter a project name
2. Select a database (PostgreSQL, SQLite, MySQL, or None)
3. Select a memory store (Redis, Valkey, or None)
4. Choose plugins (based on your database/store choices)
5. Configure Docker options
6. Confirm and generate

The generated project includes a working Litestar application with your selected options pre-configured.

Development

git clone https://github.com/Harshal6927/litestar-start.git
cd litestar-start
uv sync

Run tests:

pytest

Run linters:

make lint

License

MIT