CleanArchSharp 3.0.2

CleanArchSharp

A modern Clean Architecture template for ASP.NET Core Web APIs — production-ready with JWT auth, PostgreSQL, Redis caching, RabbitMQ messaging, and more.

src/
├── MyProject.API            ← HTTP layer (controllers, middleware)
├── MyProject.Application    ← Use cases, CQRS handlers, domain events
├── MyProject.Contracts      ← Shared DTOs, settings, interfaces
├── MyProject.Infrastructure ← External services (Redis, RabbitMQ, Stripe, etc.)
├── MyProject.Persistence    ← EF Core DbContext, migrations, seeders
└── MyProject.Domain         ← Core entities, value objects, domain interfaces

Prerequisites

Verify installation:

dotnet --version    # should be 10.0.100 or higher
psql --version      # should be 15+

Getting Started

1. Install the Template

dotnet new install CleanArchSharp@3.0.2

After installation, verify it’s available:

dotnet new list

You should see entries like:

cleanarchsharp
Clean Architecture Template for WebAPI by Sushil

Create a New API Project

dotnet new cleanarchsharp -n ProjectName

2. Configure the database

Edit src/MyProject.API/appsettings.Development.json:

{
  "ConnectionStrings": {
    "DefaultConnection": "Host=localhost;Port=5432;Database=myproject;Username=postgres;Password=your_password;"
  }
}

Tip: appsettings.*.json files are in .gitignore — they will not be committed.

3. Create the database

cd src/MyProject.API
dotnet ef database update

This applies all migrations and creates the myproject database.

4. Run the API

dotnet run

The API starts at https://localhost:5001 (or the port shown in the console).

Open Swagger UI: https://localhost:5001/swagger

Configuration Reference

appsettings.json — mandatory settings

{
  "JwtSettings": {
    "Secret": "your-32-char-min-secret-key-here!",
    "Issuer": "MyProject",
    "Audience": "MyProject"
  },
  "ConnectionStrings": {
    "DefaultConnection": "Host=localhost;Port=5432;Database=myproject;Username=postgres;Password=your_password;"
  }
}

Optional features

{
  "ConnectionStrings": {
    "Redis": "localhost:6379"       // Enables Redis caching + SignalR backplane
  },
  "RabbitMqOptions": {
    "Enabled": true,                 // Enables RabbitMQ messaging
    "Host": "localhost",
    "Username": "guest",
    "Password": "guest"
  },
  "PushKit": {
    "Fcm": { "ProjectId": "..." },  // Firebase Cloud Messaging
    "Apn": { "BundleId": "..." }    // Apple Push Notification
  },
  "GoogleOAuth": {
    "ClientId": "...",
    "ClientSecret": "..."
  },
  "Stripe": {
    "SecretKey": "...",
    "WebhookSecret": "..."
  }
}

Database Seeding

Seed roles & resources

cd src/MyProject.API
dotnet run seed role

This creates: SuperAdmin, Admin, User roles + all system resources.

Seed subscription plans

dotnet run seed plan

Seed currencies

dotnet run seed currency

Seed email templates

dotnet run seed mail-templates

Create users

dotnet run seed user <email> <password> <name> <role>

Examples:

# SuperAdmin
dotnet run seed user superadmin@myproject.com SuperAdmin@123 "Super Admin" SuperAdmin

# Admin
dotnet run seed user admin@myproject.com Admin@123 "Admin User" Admin

# Regular user
dotnet run seed user user@myproject.com User@123 "Regular User" User

Developer Workflow

Add a new migration

cd src/MyProject.API
dotnet ef migrations add MigrationName

Run tests

dotnet test

Architecture rules

Program.cs only imports MyProject.Application.DependencyInjection and MyProject.Contracts.Interfaces. All DI wiring is handled by ApplicationLayerBootstrapper.

Project Features

IDE Integration (Visual Studio & JetBrains Rider)

CleanArchSharp appears in the New Project dialog in:

Visual Studio

1. Open File → New → Project

2. Search for CleanArchSharp

3. Choose:

   • CleanArchSharp Solution Template
   • CleanArchSharp API Template

JetBrains Rider

1. Go to New Solution

2. Search for CleanArchSharp

3. Select your desired template and framework