Petabridge.Templates

.NET CLI templates for Petabridge-style projects.

Goals

The goal of this project is provide templates for creating professional-quality OSS projects that do the following:

Have unit tests;
Have performance tests;
Have documentation;
Have build system support, x-plat; and
Have standardized conventions that allow all of the above to be extended and workable.

Installation and Use

To use these templates, execute the following command on the dotnet CLI:

dotnet new -i "Petabridge.Templates::*"

This will download the latest available Petabridge.Templates package from NuGet and install it into your CLI.

After the installation process is complete, you'll see all of the templates included in the Petabridge.Templates package listed in your set of available templates if you execute the dotnet new -l command:

Template Name                                       Short Name           Language    Tags
--------------------------------------------------  -------------------  ----------  --------------------------
Class Library                                       classlib             [C#],F#,VB  Common/Library
Console App                                         console              [C#],F#,VB  Common/Console
Petabridge .NET Core Library                        pb-lib               [C#]        Petabridge/DocFx/Tests
Petabridge Akka.Cluster Starter App                 pb-akka-cluster      [C#]        Petabridge/DocFx/Tests
Petabridge ASP.NET Core + Akka.Cluster Starter App  pb-akka-web          [C#]        Petabridge/DocFx/Tests

To uninstall the package, use the following command:

dotnet new -u Petabridge.Templates

Available Templates

The following templates are installed as part of your Petabridge.Templates installation:

Template Name	Short Name	Description
Petabridge.Library	pb-lib	A professional .NET Core project setup including build scripts, documentation, unit tests, and performance tests for a class library project.
Petabridge.App	pb-akka-cluster	Creates a headless .NET 6 service that includes full Akka.NET clustering support, Docker support, documentation, and build systems.
Petabridge.App.Web	pb-akka-web	Does the same as `pb-akka-cluster`, but hosts Akka.NET inside an ASP.NET Core 6 simple web application.

You can read more about how these templates work by clicking on their titles and reading the README.md for each individual project.

To use one of these templates, you can use the dotnet new command followed by the name or shortname.

dotnet new pb-lib [-n name] [other arguments]

So for instance, if I execute dotnet new pb-lib -n "MyProject" the following output will appear in my working directory:

D:\MyProject\.nuke
D:\MyProject\build.cmd
D:\MyProject\build.ps1
D:\MyProject\build.sh
D:\MyProject\MyProject.sln
D:\MyProject\README.md
D:\MyProject\RELEASE_NOTES.md
D:\MyProject\build
D:\MyProject\build\_build.csproj
D:\MyProject\build\Build.CI.GitHubActions.cs
D:\MyProject\build\Build.cs
D:\MyProject\build\Configuration.cs
D:\MyProject\build\Directory.Build.props
D:\MyProject\build\Directory.Build.targets
D:\MyProject\docs
D:\MyProject\docs\api
D:\MyProject\docs\articles
D:\MyProject\docs\docfx.json
D:\MyProject\docs\images
D:\MyProject\docs\index.md
D:\MyProject\docs\toc.yml
D:\MyProject\docs\api\index.md
D:\MyProject\docs\articles\index.md
D:\MyProject\docs\articles\toc.yml
D:\MyProject\docs\images\icon.png
D:\MyProject\src
D:\MyProject\src\Directory.Build.props
D:\MyProject\src\MyProject
D:\MyProject\src\MyProject.Tests
D:\MyProject\src\MyProject.Tests.Performance
D:\MyProject\src\MyProject\Class1.cs
D:\MyProject\src\MyProject\MyProject.csproj
D:\MyProject\src\MyProject.Tests\MyProject.Tests.csproj
D:\MyProject\src\MyProject.Tests\UnitTest1.cs
D:\MyProject\src\MyProject.Tests.Performance\MyProject.Tests.Performance.csproj
D:\MyProject\src\MyProject.Tests.Performance\UnitTest1.cs

I'll have a new .NET 6 library project complete with a cross-platform build system, documentation, unit tests, performance tests, and a README explaining how all of the above work ready to go from day one.

See the official dotnet new documentation for more information on the sorts of options that are available when using project templates.

Questions, Comments, and Suggestions

We accept pull requests! Please let us know what we can do to make these templates more useful, extensible, or easier to use.

About Petabridge

Petabridge is a company dedicated to making it easier for .NET developers to build distributed and high-performance applications in .NET.