ProductionReady.Microservice.Template 1.0.1

Production-Ready .NET 8 Microservice Template

A comprehensive, production-ready .NET 8 microservice template that follows Clean Architecture principles and implements CQRS pattern with enterprise-grade features.

🚀 Quick Start

Install the Template

# Install from NuGet (once published)
dotnet new install ProductionReady.Microservice.Template

# Or install from local package
dotnet new install ProductionReady.Microservice.Template.1.0.0.nupkg

Create a New Microservice

# Basic usage
dotnet new microservice -n UserManagement -CompanyName Acme

# With custom options
dotnet new microservice -n OrderProcessing -CompanyName Acme -Port 5100 -HttpsPort 5101 --EnableDocker true --EnableKubernetes true

Available Parameters

🏗️ Architecture

The template follows Clean Architecture with these layers:

├── src/
│   ├── {Company}.{ServiceName}.Domain/           # Domain entities and business rules
│   ├── {Company}.{ServiceName}.Application/      # Business logic and CQRS handlers
│   ├── {Company}.{ServiceName}.Infrastructure/   # Data access and external services
│   └── {Company}.{ServiceName}.Api/             # REST API controllers and configuration
├── tests/
│   ├── {Company}.{ServiceName}.Application.Tests/ # Unit tests
│   └── {Company}.{ServiceName}.Api.Tests/        # Integration tests
├── docker/                                      # Docker configuration
├── k8s/                                         # Kubernetes manifests
└── .github/workflows/                           # CI/CD pipeline

✨ Features Included

🏛️ Architecture & Patterns

• Clean Architecture with proper dependency inversion
• CQRS pattern with MediatR
• Domain-Driven Design principles
• Repository pattern with Entity Framework Core
• Decorator pattern for cross-cutting concerns

🔧 Technical Features

• .NET 8 with latest features
• Entity Framework Core 8 for data access
• MediatR for CQRS implementation
• FluentValidation for input validation
• AutoMapper for object mapping
• Serilog for structured logging

🛡️ Security & Reliability

• Global exception handling middleware
• Request/Response logging middleware
• Security headers configuration
• CORS configuration
• Health checks with multiple endpoints
• Input validation with custom error responses

🐳 DevOps & Deployment

• Docker support with multi-stage builds
• Docker Compose for local development
• Kubernetes manifests for production deployment
• GitHub Actions CI/CD pipeline
• Health checks for container orchestration

🧪 Testing

• Unit tests with xUnit
• Integration tests with TestHost
• Test utilities and fixtures
• Code coverage configuration

🚀 Getting Started with Generated Project

After creating your microservice:

1. Build and Run Locally

cd YourServiceName
dotnet build
dotnet run --project src/YourCompany.YourServiceName.Api

2. Run with Docker

docker build -t yourservice .
docker run -p 5000:5000 yourservice

3. Run with Docker Compose

docker-compose up

4. Deploy to Kubernetes

kubectl apply -f k8s/

📊 API Endpoints

The generated microservice includes:

• GET /health - Health check endpoint
• GET /health/ready - Readiness probe
• GET /health/live - Liveness probe
• GET /swagger - API documentation
• GET /api/weatherforecast - Sample endpoint

🔧 Configuration

appsettings.json

{
  "Serilog": {
    "MinimumLevel": "Information"
  },
  "AllowedHosts": "*",
  "Cors": {
    "AllowedOrigins": ["http://localhost:3000"]
  }
}

Environment Variables

🧪 Testing

# Run all tests
dotnet test

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

# Run specific test project
dotnet test tests/YourCompany.YourServiceName.Application.Tests

📚 Documentation

The generated project includes:

• README.md - Project overview and setup instructions
• API documentation - Swagger/OpenAPI specs
• Architecture decision records - In the docs/ folder
• Deployment guides - Docker and Kubernetes instructions

🤝 Contributing

1. Fork the template repository
2. Create a feature branch
3. Make your changes
4. Test the template generation
5. Submit a pull request

📄 License

This template is licensed under the MIT License. See the LICENSE file for details.

🏷️ Template Management

Uninstall Template

dotnet new uninstall ProductionReady.Microservice.Template

List Installed Templates

dotnet new list

Template Help

dotnet new microservice --help

Happy coding! 🎉

Create robust, scalable microservices with this production-ready template that follows industry best practices and includes everything you need to get started quickly.