Metadata-Version: 2.4
Name: litestar-start
Version: 0.1.0a2
Summary: Interactive CLI to scaffold fullstack projects with modular choices
Project-URL: Documentation, https://github.com/Harshal6927/litestar-start#readme
Project-URL: Issues, https://github.com/Harshal6927/litestar-start/issues
Project-URL: Source, https://github.com/Harshal6927/litestar-start
Author-email: Harshal Laheri <harshal@harshallaheri.me>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,fullstack,generator,litestar,scaffolding,template
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Code Generators
Requires-Python: >=3.10
Requires-Dist: jinja2>=3.1.6
Requires-Dist: msgspec>=0.20.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: questionary>=2.1.1
Requires-Dist: rich>=14.2.0
Description-Content-Type: text/markdown

# Litestar Start

**Litestar Start** is an interactive CLI tool designed to scaffold production-ready fullstack applications with modular choices. It combines modern python tooling with established patterns to get you up and running quickly.

## Features

*   **Interactive CLI**: Beautiful terminal interface using `rich` and `questionary`.
*   **Backend Frameworks**:
    *   [Litestar](https://litestar.dev/)
    *   [FastAPI](https://fastapi.tiangolo.com/)
*   **Frontend Frameworks**:
    *   [React](https://react.dev/)
*   **Database Support**:
    *   PostgreSQL
    *   MySQL
    *   SQLite
    *   MongoDB
*   **ORM Integration**:
    *   [SQLAlchemy](https://www.sqlalchemy.org/)
*   **Tooling**:
    *   Docker & Docker Compose support
    *   GitHub Actions CI/CD workflows
    *   Ruff & Pre-commit linting configuration

## Installation

You can install and run `litestar-start` using `uvx` or `pipx`:

```bash
uvx litestar-start

# or

pipx run litestar-start
```

## Usage

Simply run the command and follow the interactive prompts:

```bash
litestar-start
```

You will be asked to configure:
1.  **Project Details**: Name and description.
2.  **Tech Stack**: Backend, Frontend, Database, ORM.
3.  **Features**: Docker, CI/CD, Testing, Linting.

## Contributing

We welcome contributions! Whether it's adding a new framework, fixing a bug, or improving documentation.

Please read our [Developer Guide](DEVELOPMENT.md) to get started with setting up the project locally.

## License

MIT
