Skip to content
Unreleased documentation. These pages describe current development source and may change before release. Use stable 1.0.0

Exercised Examples

These examples already exist in the repository and run in current quality gates. For outcome-oriented walkthroughs, start with the practical cookbook or the complete Orders API recipe.

Orders Application

examples/orders is the reference contract-to-cloud application.

SliceWhat it demonstratesEvidence
OpenAPIhealth plus complete order resource familycontract validation and deterministic sync
Domainorder invariants and revision transitionspure unit tests
Applicationauthorization and validation before portsfake-port tests
Memory adapteridempotent replay and conflict behaviorlocal behavior tests
SQLite adaptermigrations, persistence, cursors, atomic update/deletereal SQLite tests
PostgreSQL adapterthe same behavioral contractcompiled; requires configured ignored tests
Axum APIenvelopes, pagination, ETags, auth, Problem responsesin-process router tests
Lambda and workernative runtime entry pointslocal build/release qualification

Start with the openapi.yaml, then follow one operation through domain, application, adapters, api, and service.

Third-Party-Style Plugin

examples/plugins/third-party-minimal is a standalone Cargo workspace with versioned dependencies and source path overrides.

bash
cargo test \
  --manifest-path examples/plugins/third-party-minimal/Cargo.toml \
  --all-features --locked

It proves the public package API, strict distribution record, concrete plugin lifecycle, deterministic registration provenance, and explicit provider_live: not_run boundary.

Generated PostgreSQL and SQLite Applications

scripts/test/generated_apps.sh creates fresh applications for both database profiles, compiles and tests their initial vertical slices, exercises module, migration, seeder, worker, adapter, operation, and plugin generators, then confirms generated TODO specifications fail visibly.

The script proves generation and compiler integration. It does not connect to a configured PostgreSQL server or deploy either application.

Feedback Plugin

plugins/minco-plugin-feedback demonstrates a larger first-party plugin: contract routes, a framework-free widget, attachments, transcription boundaries, events, audit, notifications, client tokens, persistence, and browser tests.

Its browser matrix is local UI evidence. Provider transcription, production storage, and live notification delivery remain separate.

Worker and AWS Adapter Examples

The minco-aws-worker example exercises partial SQS batch failure, FIFO fail-forward behavior, bounded concurrency, and redacted message diagnostics. AWS adapters include ignored Rustack and bounded real-AWS tests. Ignored tests are compiled evidence, not a claim that the provider ran.

Pick an Example by Goal

GoalExample or guideStrongest default evidence
Standard HTTP CRUDOrders API end to endlocal contract/domain/application/SQLite/HTTP tests
Generated applicationBuild your first applicationcompiler and local profile
External plugin packageTest a Pluginpublic offline conformance
SQS partial batchesQueues and workerslocal runtime and Plan IR tests
Client review loopFeedbacklocal persistence/API/widget/browser tests
Deployment reviewPlan an AWS Deploymentdeterministic offline plan/package evidence
Evidence interpretationTesting and Evidenceexplicit boundary vocabulary

Minimal cost, maximum capability.