Superhero Team Management

🚀 SSW ネットアーキテクチャテンプレートの使用ガイド

このドキュメントでは、SSWネットアーキテクチャテンプレートを使用して新しいASP.NET Core APIプロジェクトを作成する方法を説明します。このテンプレートは、完全なインフラストラクチャとアプリケーション層の構造を提供し、開発者が迅速に開発を開始できるよう支援します。

🚀 クイックスタート

テンプレートのインストール

1. SSWネットアーキテクチャテンプレートをインストールします。

dotnet new install HeroApi.Template

⚠️ 重要提示

テンプレートは一度だけインストールすればよく、デフォルトでは自動的に最新バージョンに更新されます。

2. 新しいディレクトリを作成します。

mkdir Northwind365
cd Northwind365

3. 新しいソリューションを作成します。

dotnet new ssw-ca

⚠️ 重要提示

nameパラメータはオプションです。指定しない場合、デフォルトでディレクトリ名がソリューション名とプロジェクトの名前空間として使用されます。

機能モジュールの追加

1. クエリ機能を追加します。

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

2. コマンド機能を追加します。

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

ソリューションの実行

1. ツールディレクトリに移動します。

   Windows:

   cd tools\AppHost\
   

   Mac/Linux:

   cd tools/AppHost/
   

2. プロジェクトを実行します。

dotnet run

⚠️ 重要提示

初回実行時は、Dockerイメージのダウンロード、データベースの作成、データの初期化に数分かかる場合があります。

3. ブラウザを開き、以下のURLにアクセスします。 https://localhost:7255/scalar/v1

テンプレートの公開

CleanArchitecture.nuspecファイルのメインブランチに変更を加えると、テンプレートは自動的にNuGet.orgに公開されます。

公開フロー

1. CleanArchitecture.nuspecファイルのversion属性を更新します。
2. コードのコミットをマージします。
3. GitHub Actionsが自動的にpackageワークフローを実行し、新しいバージョンをNuGet.orgに公開します。
4. GitHubリリースを作成して更新内容を記録します。

⚠️ 重要提示

私たちはCalVerバージョン番号形式（例：YYYY.M.D、例えば2024.2.12）を採用しています。

✨ 主な機能

• 完全なインフラストラクチャとアプリケーション層の構造を提供し、開発者が迅速に開発を開始できるよう支援します。
• テンプレートの自動更新機能により、常に最新バージョンを使用できます。
• 簡単なコマンドで機能モジュールを追加できます。

📚 ドキュメント

学習リソース

トレーニングコース

SSWネットアーキテクチャを深く学びたい場合は、以下のイベントに参加できます。

• SSW 一日净架构超级能力巡讲
• SSW 两日净架构工作坊

学習資料

以下のビデオを参考にして、クリーンアーキテクチャの知識を学ぶことができます。

• Clean Architecture with ASP.NET Core and MAUI

また、以下のリソースリンクも参考にできます。

• .NET 開発ドキュメント
• SSW公式ドキュメント

🤝 貢献とサポート

コードの貢献や問題の報告が必要な場合は、GitHubリポジトリをご利用ください。

📄 ライセンス

このプロジェクトはMIT Licenseに準拠しています。