Quick Start
Perigon provides two templates with different boundaries. Choose a template first, then follow its creation, run, test, and deployment guide.
| Template | Best for | Technical boundary | Quick start |
|---|---|---|---|
ApiStandard |
Conventional Web APIs, admin services, and modular business systems | EF Core, an Aspire migration resource, AdminService/ApiService, PostgreSQL or SQL Server | ApiStandard quick start |
MiniApi |
Lightweight APIs, microservices, and resource-sensitive workloads | Minimal API, PostgreSQL, NativeAOT, no built-in EF migration resource | MiniApi quick start |
Common prerequisites
- Install the
.NET 10.0.103SDK or a compatible .NET 10 SDK. - Install an Aspire CLI matching the selected template SDK: ApiStandard uses 13.6.1 and MiniApi uses 13.5.0. Prepare Docker or Podman.
- Install
Perigon.CLIand create a project withdotnet new, or use Studio to create a solution.
When using the templates directly, install the package version covered by this documentation:
dotnet new install Perigon.templates --version 1.3.17
See the version compatibility matrix for the template package, Aspire SDK, and CLI mapping.
Run and troubleshoot
Use the Aspire CLI to manage AppHost:
aspire start --non-interactive aspire ps aspire otel logs
Stop the application:
aspire stop --non-interactive
Before production deployment, read Production Operations Runbook and Deploying Applications.
In this article