koan-quickstart

What problem does it solve?

The initial setup and boilerplate for new projects can be a significant time sink. This Skill provides a streamlined, step-by-step guide to get a fully functional Koan Framework application with a REST API and data persistence running in under 10 minutes.

Core Features & Use Cases

• Rapid Project Creation: Quickly scaffold a new .NET web project and add essential Koan packages.
• Minimal Program.cs: Achieve a complete application bootstrap with just a few lines of code, leveraging Koan's auto-registration.
• Instant CRUD API: Define an entity and get a full REST API (GET, POST, PUT, DELETE, PATCH) automatically generated with EntityController<T>.
• Zero-Config Data Storage: Start with JSON file storage for immediate development, then seamlessly switch to a real database like PostgreSQL with minimal changes.
• Use Case: Need to quickly prototype a new service with a backend API? This Skill lets you define your data model, expose it via REST, and persist data in minutes, ready for testing and iteration.

Quick Start

1. Create project: dotnet new web -n MyKoanApp && cd MyKoanApp
2. Add packages: dotnet add package Koan.Core Koan.Data.Core Koan.Data.Connector.Json Koan.Web
3. Minimal Program.cs: using Koan.Core; var builder = WebApplication.CreateBuilder(args); builder.Services.AddKoan(); var app = builder.Build(); app.Run();
4. Create Models/Todo.cs: using Koan.Data.Core; public class Todo : Entity<Todo> { public string Title { get; set; } = ""; public bool Completed { get; set; } }
5. Create Controllers/TodosController.cs: using Koan.Web; using Microsoft.AspNetCore.Mvc; [Route("api/[controller]")] public class TodosController : EntityController<Todo> { }
6. Run: dotnet run