🎹 Chopin CLI

Scaffolding and code generation tool for the Chopin web framework.

Generate ChopinModules following MVSR pattern (Model-View-Service-Router), manage migrations, and bootstrap new projects with sensible defaults.

Installation

cargo install chopin-cli

Quick Start

Create a new Chopin project with modular architecture:

chopin new my-app
cd my-app
cargo run

Commands

new — Create a new project

chopin new my-project [--template basic|api]

Creates a new Chopin project with:

• Modular architecture using ChopinModule trait
• MVSR pattern (Model-View-Service-Router)
• Configured Cargo.toml with dependencies
• Example auth module (signup, login)
• Development SQLite database
• OpenAPI documentation setup

Templates:

• basic — Minimal setup (default)
• api — Full CRUD API with posts module

generate module — Scaffold a new module

chopin generate module blog

Generates MVSR structure:

src/modules/blog/
├── mod.rs           # ChopinModule implementation
├── services.rs      # Business logic (unit-testable)
├── handlers.rs      # HTTP handlers
├── models.rs        # SeaORM entities
└── migrations.rs    # Database migrations

generate — Generate specific components

chopin generate service posts      # Service layer
chopin generate handler posts      # HTTP handler
chopin generate model post         # SeaORM entity
chopin generate migration create_posts_table

db — Database management

chopin db migrate
chopin db reset

Features

• ⚡ Zero-configuration project setup with MVSR pattern
• 📦 ChopinModule scaffolding
• 🔐 Built-in authentication scaffolding
• 🗄️ Database migration helpers
• 📚 OpenAPI documentation
• 🧪 Testing utilities included

Documentation

For more information, see the main repository:

• Modular Architecture Guide — ChopinModule trait, MVSR pattern
• Debugging & Logging — Enable request logging
• Example Projects — basic-api shows MVSR pattern
• API Reference

License

WTFPL (Do What The Fuck You Want To Public License)