ποΈ A modern and easy-to-use boilerplate for building .NET API client wrappers (also known as SDKs).
This repository is a template designed to kickstart your journey in creating robust API client wrappers using .NET C#.
Save time and effort with a preconfigured solution that includes essential tools and CI pipeline setup.
π§ Key features:
- π οΈ .NET Solution Setup: Ready-to-use structure for source code, unit tests, and integration tests.
- β
CI Integration: Includes a sample AppVeyor CI pipeline configuration with
appveyor.yml
.π‘ Tip: AppVeyor is free for open-source projects. Consider alternatives like GitHub Actions, CircleCI, or Azure DevOps for private repositories.
Follow these quick steps for a hassle-free experience:
- Click the green "Use this template" button at the top.
- Name your new repository and clone it to your machine.
- Run the initial setup script:
- πͺ On Windows: Execute
initial-setup.bat
orinitial-setup.ps1
- π§ On Linux/Mac: Execute
initial-setup.sh
- πͺ On Windows: Execute
- Follow the prompts and enjoy! π
Would you prefer to do it step-by-step? No problem!
-
Click the green "Use this template" button.
-
Clone your newly created repository.
-
Delete this file (
README.md
) and renameREADME.template.md
toREADME.md
. -
Update the following files with your project details:
appveyor.yml
β Add secure tokens or configure your preferred CI tool.SolutionName.sln
β Replace with your solution name.- Project files (
SolutionName.csproj
,SolutionName.Tests.csproj
,SolutionName.IntegrationTests.csproj
).- Update namespaces and project names inside the
Src
andTests
directories.
- Update namespaces and project names inside the
README.md
β Fix badge paths ({username}/{repo}
) and add usage instructions._config.yml
β Update with project details for the GitHub Pages documentation site.
-
βοΈ Final touches:
- Adjust test project references in
Tests/SolutionName.Tests.csproj
andTests/SolutionName.IntegrationTests.csproj
. - Update the package name in your main project file.
- Adjust test project references in
π This project is licensed under the MIT License.
Feel free to use it as is or replace it with a license that suits your needs.
π View LICENSE | Read More About MIT
π¬ Questions? Ideas? Open an issue or fork this repository to make it your own!
Don't forget to β star the project if this template saved you time. π
π· Happy Coding in .NET! π―