PiBox is a service hosting framework
that allows .net devs
to decorate their services with behaviours or functionality (think of plugins) while only using minimal configuration
.
"PiBox" because we want to support unlimited plugins within the api out of the box!
Before you begin, ensure you have met the following requirements:
.net8 sdk
To start using PiBox components/plugins, you have to:
PiBox.Hosting.WebHost
PiBox.Hosting.Generator
Program.cs
to have following code:using PiBox.Hosting.WebHost;
PluginWebHostBuilder.RunDefault(PiBox.Generated.PiBoxPluginTypes.All);
PiBox
You can find a comprehensive documentation here
Or check the individual README files in each plugins directory
To build PiBox, follow these steps:
dotnet build ./PiBox.sln
To format and style check the solution run:
dotnet format ./PiBox.sln
We are using these frameworks for unit testing
To run unit tests for PiBox, follow these steps:
dotnet test ./PiBox.sln
To contribute to PiBox, follow these steps:
To contribute code along your issue please follow the these steps:
git checkout -b <branch_name>
.dotnet format
.git commit -m '<commit_message>'
git push origin PiBox/<branch_name>
.editorconfig
Code | Reason | Link |
---|---|---|
1701 | Assembly Referencing | 1701 |
1702 | Assembly Referencing | 1702 |
1591 | Disable XML Comments | 1591 |