Superhero Team Management

🚀 SSW Clean Architecture Template Usage Guide

This guide introduces how to use the SSW Clean Architecture Template to create a new ASP.NET Core API project. The template provides a complete infrastructure and application layer structure, enabling developers to get started quickly.

🚀 Quick Start

✨ Features

• The template offers a complete infrastructure and application layer structure, facilitating developers to initiate projects rapidly.

📦 Installation

1. Install the SSW Clean Architecture Template:

dotnet new install HeroApi.Template

⚠️ Important Note

The template only needs to be installed once and will be automatically updated to the latest version by default.

2. Create a new directory:

mkdir Northwind365
cd Northwind365

3. Create a new solution:

dotnet new ssw-ca

⚠️ Important Note

The name parameter is optional. If not specified, the directory name will be used as the solution name and project namespace by default.

💻 Usage Examples

Adding Feature Modules

Adding Query Functionality

cd src/Application/Features
mkdir {{FeatureName}}
cd {{FeatureName}}
dotnet new ssw-ca-query --name {{QueryName}} --entityName {{Entity}} --slnName {{SolutionName}}

Adding Command Functionality

cd src/Application/Features
mkdir {{FeatureName}}
cd {{FeatureName}}
dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnName {{SolutionName}}

Running the Solution

1. Navigate to the tools directory:
   • Windows:

   cd tools\AppHost\
   

   • Mac/Linux:

   cd tools/AppHost/
   

2. Run the project:

dotnet run

⚠️ Important Note

The first time you run the project, it may take a few minutes to download Docker images, create the database, and initialize the data.

3. Open your browser and visit: https://localhost:7255/scalar/v1

📚 Documentation

Publishing the Template

When changes are made to the main branch of the CleanArchitecture.nuspec file, the template will be automatically published to NuGet.org.

Publishing Process

1. Update the version attribute in the CleanArchitecture.nuspec file.
2. Merge the code commits.
3. GitHub Actions will automatically run the package workflow and publish a new version to NuGet.org.
4. Create a GitHub release to record the update content.

⚠️ Important Note

We use the CalVer version number format, such as YYYY.M.D (e.g., 2024.2.12).

Learning Resources

Training Courses

If you want to gain in - depth knowledge of the SSW Clean Architecture, you can participate in the following events:

• SSW Clean Architecture Superpowers One - Day Tour
• SSW Clean Architecture Two - Day Workshop

Learning Materials

We recommend the following video to learn about clean architecture:

• Clean Architecture with ASP.NET Core and MAUI

In addition, you can refer to the following resource links:

• .NET Development Documentation
• SSW Official Documentation

Contribution and Support

If you want to contribute code or raise issues, please visit our GitHub repository.

📄 License

This project is licensed under the MIT License.