Dotnet CLI Project Organisation Cheatsheet
Overview
Hey there, code wizard! 🧙♂️ Ready to organize your .NET Aspire Starter project like a pro? This guide will walk you through setting up your project with a neat folder structure. Let's dive in!
Steps to Create the Project
1️⃣ Generate a .NET Aspire Starter Project
First things first, let's create the project inside a folder named AspireSample:
dotnet new aspire-starter --use-redis-cache --output AspireSample
Boom! You've got yourself a shiny new .NET Aspire Starter project. 🎉
2️⃣ Move Projects to src/ and tests/
Time to get organized! Navigate into the project directory and create the required folders:
cd AspireSample
mkdir src tests # Create folders for app and test projects
Now, let's move those projects to their new homes:
Move application projects to src/
mv ExpenseTracker.ApiService src/
mv ExpenseTracker.AppHost src/
mv ExpenseTracker.ServiceDefaults src/
mv ExpenseTracker.Web src/
Move test projects to tests/
mv ExpenseTracker.Tests tests/
mv ExpenseTracker.UnitTests tests/
3️⃣ Recreate the Solution File
Since we moved the projects, we need to recreate the solution file. Out with the old, in with the new:
rm AspireSample.sln # Remove the old solution file
dotnet new sln -n AspireSample # Create a new solution file
Now, let's add the projects back to the solution:
Add application projects to the solution
dotnet sln AspireSample.sln add src/ExpenseTracker.ApiService/ExpenseTracker.ApiService.csproj
dotnet sln AspireSample.sln add src/ExpenseTracker.AppHost/ExpenseTracker.AppHost.csproj
dotnet sln AspireSample.sln add src/ExpenseTracker.ServiceDefaults/ExpenseTracker.ServiceDefaults.csproj
dotnet sln AspireSample.sln add src/ExpenseTracker.Web/ExpenseTracker.Web.csproj
Add test projects to the solution
dotnet sln AspireSample.sln add tests/ExpenseTracker.Tests/ExpenseTracker.Tests.csproj
dotnet sln AspireSample.sln add tests/ExpenseTracker.UnitTests/ExpenseTracker.UnitTests.csproj
4️⃣ Restore and Verify Everything Works
Let's make sure everything is in tip-top shape. Run the following commands to restore dependencies and build the solution:
dotnet restore
dotnet build
If everything runs without errors, give yourself a pat on the back! Your project is properly structured! 🎉
5️⃣ Open the Solution in an IDE
Now you can open the solution in your favorite IDE and start coding like a boss:
# VS Code
code AspireSample
# Visual Studio / Rider
open AspireSample.sln
And there you have it! Your .NET Aspire Starter project is all set up and ready to rock. 🚀
Happy coding!
If you have enjoyed this post, please consider buying me a coffee ☕ to help me keep writing!