Documentation

The template ships with a full set of guides in its docs/ folder (architecture, security, data access, deployment and more). This page gets you from purchase to a running app.

Requirements

  • .NET 10 SDK
  • Node.js 22 and pnpm
  • Docker Desktop (for PostgreSQL and the other services Aspire starts)
  • Optional: the .NET MAUI workload, for the mobile app

1. Install the template from your private feed

After you buy, the licence email contains your feed token. You can make a new one at any time in your account; the old one then stops working.

dotnet nuget add source https://feed.buildrite.dev/v3/index.json \
  --name BuildRite --username <your purchase email> --password <your feed token> \
  --store-password-in-clear-text
dotnet new install BuildRite.Templates

To update later, run dotnet new install BuildRite.Templates again. Your licence includes every future version.

2. Create your app

dotnet new buildrite -n MyApp --licenseKey "<your licence key>"
cd MyApp
dotnet dev-certs https --trust
dotnet run --project src/Server/MyApp.AppHost

The Aspire dashboard opens with links to the API and the web app. In Development, the API log prints a demo admin account. See Features for the template options (--multitenancy, --billing, --mobile).

3. Apply your licence key

Any one of these:

  • When creating the app: --licenseKey "<key>" writes it into appsettings.json.
  • On a server: set the environment variable License__Key.
  • In a running app: paste it on the admin License page.

Your app never stops because of its licence. Without a valid key, platform admins see a banner and the log shows a warning. Your key is in the purchase email, and you can copy it or download license.txt from your account.

Seats

A licence covers one developer per seat. Need more? Add seats from your account; you'll get an updated key.

Help

Check the FAQ, or contact us.