Awesome

C# Bootstrap (base / project skeleton)

• C# Bootstrap (base / project skeleton)
  • Introduction
  • Prerequisite
  • How To Start
    • Use the Template
    • Working with the workspace
  • About
  • 💡 Related repositories
  • License

Introduction

This is a repository intended to help you create all the boilerplate to just have a test and library projects in C#. It could be useful if you want to start from scratch a kata or a little exercise or project.

This template will create:

• A */Tests NUnit test project using FluentAssertions, NSubstitute, and Faker.NET.
• A */Domain project to write your "productive" code.
• A working test using a reference to */Domain project.
• A .gitignore file to just include relevant files in your repository.
• A pre-commit configuration in order to follow conventional-commits and formatting c# files.

Prerequisite

• .NET7 SDK
• pre-commit

How To Start

Use the Template

You have two main ways of starting a project from this template:

• Use this template button from Github interface.
• Using dotnet tamplate: dotnet new codely-basic --name <YourProjectName>. First, you need to install the template by:
  1. Clone the repository
  2. Run: dotnet new install ./

While first is easier from GitHub interface, second one allow you to have a local way of creating as many projects you want with this structure just by installing the template the first time.

Working with the workspace

1. Install pre-commit hooks with: pre-commit install --install-hooks -t pre-commit -t commit-msg
2. Build the project: dotnet build
3. Run tests: dotnet test.
4. Start coding!

About

This hopefully helpful utility has been developed by CodelyTV and contributors.

We'll try to maintain this project as simple as possible, but Pull Requests are welcomed!

💡 Related repositories

• TypeScript Basic Skeleton
• Java Basic Skeleton
• PHP Basic Skeleton
• Scala Basic Skeleton

License

The MIT License (MIT). Please see License File for more information.