Repositories
The Payroll Engine consists of the following GitHub repositories.
| Repository | Content | Details | Third party components |
|---|---|---|---|
PayrollEngine (MIT) |
Main repository |
  
|
x |
PayrollEngine.Core (MIT) |
Core payroll objects |
  
|
x |
PayrollEngine.Serilog (MIT) |
System logger 1) |
  
|
Serilog (Apache 2.0) |
PayrollEngine.Document (MIT) |
Report generation 2) |
  
|
FastReport (MIT) NPOI (Apache 2.0) |
PayrollEngine.Client.Core (MIT) |
Client core payroll objects |
  
|
x |
PayrollEngine.Client.Test (MIT) |
Client test library |
  
|
x |
PayrollEngine.Client.Scripting (MIT) |
Client scripting |
  
|
docfx (MIT) 3) xunit (Apache 2.0) |
PayrollEngine.Client.Services (MIT) |
Client services 4) |
 
|
docfx (MIT) 3) |
PayrollEngine.Backend (MIT) |
Backend server application |
 
|
Mapperly (Apache 2.0) Swashbuggle (MIT) SqlKata (MIT) Dapper (Apache 2.0) Serilog (Apache 2.0) xunit (Apache 2.0) |
PayrollEngine.PayrollConsole (MIT) |
Console application |
 
|
NPOI (Apache 2.0) Serilog (Apache 2.0) |
PayrollEngine.WebApp (MIT) |
Web application |
 
|
MudBlazor (MIT) LocalStorage (MIT) Serilog (Apache 2.0) |
PayrollEngine.JsonSchemaBuilder (MIT) |
JSON schema generator |
 
|
NJSonSchema (MIT) |
PayrollEngine.SqlServer.DbQuery (MIT) |
SQL Server query tool |
|
x |
1) Loggers can be integrated through the PayrollEngine.ILogger interface.
2) Report and document generator can be integrated through the PayrollEngine.Document.IDataMerge interface.
3) Static HTML documentation.
5) NuGet entry package.
| 👍 Many thanks to all who supported the open source idea. Only this way this project could be created. |
|---|
By referencing the NuGet package PayrollEngine.Client.Services, the engine can be included in .NET clients.
<PackageReference Include="PayrollEngine.Client.Services" Version="0.6.0-beta.4" />To develop payroll client applications and regulation scripts, the developer can use the following reference guides
-
Services Reference- contains all client service classes -
Script Reference- description of script classes
The documentation can be downloaded as a zip file from the Release Assets. After unzipping the zip file, index.html is the start page of the documentation.
The HTML Help can also be launched as a Web application that supports a dark mode display (see Client Scripting and Client Services).
🤝 Thank you for supporting this project with a donation.
⚡ This is a pre-relase version of the initial development, please read the restrictions.
