Quick start · Docs — DomainCraft

DomainCraft turns a single domain.yaml file into fully working source code for a target language and framework. This quick start takes you from zero to a running C# REST API in four steps.

1. Install the CLI

No Go toolchain required. Download the prebuilt binary for your platform from GitHub Releases:

Download from GitHub Releases

Alternatively, if Go is already installed on your machine:

go install github.com/DomainCraft/DomainCraft/cmd/domaincraft@latest

2. Create a project

Create a domain.yaml by hand or in the visual editor (DomainCraft Studio). A minimal starter looks like:

project:
  name: MyShop
  version: 1.0.0

database: postgresql
auth:
  type: jwt
api_style: rest

entities:
  User:
    fields:
      id: uuid [primary]
      email: string [required, unique, email]
      name: string [required]
      password: string [required, hidden]

3. Define your domain

Edit domain.yaml. This is all you write — the generator produces everything else:

project:
  name: MyShop

database: postgresql

auth:
  type: jwt
  entity: User
  roles: [Admin, User]   # roles referenced in permissions must be declared here

entities:
  Product:
    features: [audit, soft_delete]
    fields:
      id: uuid [primary]
      title: string [required, min:3, max:200]
      price: decimal [required, gte:0]
    permissions:
      read: ["*"]
      create: [Admin]
      update: ["@Owner", Admin]

Validate it at any time:

domaincraft validate --domain domain.yaml

4. Generate & run

domaincraft generate --domain domain.yaml --bridge csharp-restful
cd generated
dotnet run --project src/WebApi

You now have a complete, compilable backend — entities, repositories, controllers, auth, migrations, Docker and Kubernetes manifests. The next guide walks through a fuller example with relations and features.