Sylin.Koan

Koan Framework

Build services like you're talking to your code, not fighting it.

Koan is a modular .NET backend framework for developers who value clarity, comfort, and the ability to grow. Whether you're spinning up a quick prototype or scaling into enterprise-grade patterns, Koan keeps the path clear.

🚀 Quick Start

# Create project
dotnet new web && dotnet add package Koan.Core Koan.Web Koan.Data.Sqlite

# Add model
echo 'public class Todo : Entity<Todo> { public string Title { get; set; } = ""; }' > Todo.cs

# Add controller  
echo '[Route("api/[controller]")] public class TodosController : EntityController<Todo> { }' > TodosController.cs

# Run
dotnet run

That's a full REST API. Visit /swagger to explore.

📚 Documentation

• 5-Minute Quickstart - Get running now
• Complete Documentation - Comprehensive guides and reference
• Framework Overview - Architecture and capabilities
• Getting Started Guide - Full walkthrough

🌱 Key Features

• Start Simple: Real service in a single file
• Entity-First: Models drive your API automatically
• Modular: Add AI, messaging, vector search as you grow
• Production-Ready: Health checks, observability, security built-in
• No Lock-in: Escape hatches everywhere

🧱 Pillars

🛠️ CLI & Orchestration

# Install CLI
./scripts/cli-all.ps1

# Export Docker Compose for local dependencies
Koan export compose --profile Local

# Run dependencies with health checks
Koan up --profile Local --timeout 300

📦 Requirements

• .NET 9 SDK
• Current Version: v0.2.18

🤝 Contributing

See CONTRIBUTING.md for guidelines.

📄 License

Apache 2.0 - See LICENSE for details.