The documents of the template

DotNetSolutionKit is a dotnet new template for .NET 8 microservices on PostgreSQL. These are its documents: how to generate a solution, how a service is built, what each switch adds, how it runs in production and why it is made the way it is.

Every document below is a markdown file in the repository, and each link goes to its source.

Getting started

• Generating a solution · docs/getting-started/generating-a-solution.md
• Versions of the template · docs/getting-started/upgrading.md
• The documentation at a glance · docs/README.md
• Roadmap · docs/roadmap.md

Architecture

• Projects and layers · docs/architecture/projects-and-layers.md
• Web layer · docs/architecture/web-layer.md
• Errors · docs/architecture/errors.md
• Validation and pagination · docs/architecture/validation-and-pagination.md
• Authentication and permissions · docs/architecture/authentication-and-permissions.md
• Persistence · docs/architecture/persistence.md
• Domain events · docs/architecture/domain-events.md
• Testing · docs/architecture/testing.md

Features

• Background jobs · docs/features/background-jobs.md
• Message bus · docs/features/messaging.md
• Secrets from Infisical · docs/features/secrets.md
• Feature flags · docs/features/feature-flags.md
• API diff · docs/features/api-diff.md
• CI on GitHub Actions · docs/features/ci.md
• Access rules over a tenant tree · docs/features/hierarchy-rules.md
• Object storage · docs/features/object-storage.md
• ClickHouse · docs/features/clickhouse.md
• Audit journal · docs/features/audit.md
• API gateway · docs/features/api-gateway.md

Operations

• Docker · docs/operations/docker.md
• Deployment · docs/operations/deployment.md
• Health · docs/operations/health.md
• Startup checks · docs/operations/startup-checks.md
• Switching dependencies off · docs/operations/switching-dependencies-off.md

Decisions

• ADR-001: Domain events in three phases · docs/adr/001-three-phase-domain-events.md
• ADR-002: Repositories on specifications · docs/adr/002-repositories-on-specifications.md
• ADR-003: The API document from the built application · docs/adr/003-api-schema-generation.md
• ADR-004: The product version by hand · docs/adr/004-product-version-by-hand.md
• ADR-005: How a service is tested · docs/adr/005-testing-a-service.md