Repositories

Repositories

GitHub Repositories

The Payroll Engine consists of the following GitHub repositories:

Repository	Content	NuGet package	Third party components
PayrollEngine.git	Main repository		x
PayrollEngine.JsonSchemaBuilder.git	JSON schema generation		NJSonSchema [MIT]
PayrollEngine.SqlServer.DbQuery.git	SQL-Server query tool		x
PayrollEngine.Core.git	Core payroll objects	PayrollEngine.Core	x
PayrollEngine.Serilog.git	System logger 1)	PayrollEngine.Serilog	Serilog [Apache 2.0]
PayrollEngine.Document.git	Report generation 2)	PayrollEngine.Document	FastReport [MIT] NPOI [Apache 2.0]
PayrollEngine.Client.Core.git	Client core payroll objects	PayrollEngine.Client.Core	x
PayrollEngine.Client.Test.git	Client test library	PayrollEngine.Client.Test	x
PayrollEngine.Client.Scripting.git	Client scripting	PayrollEngine.Client.Scripting	docfx [MIT] 3) xunit [Apache 2.0]
PayrollEngine.Client.Services.git	Client services	PayrollEngine.Client.Services 4)	docfx [MIT] 3)
PayrollEngine.Backend.git	Payroll Engine backend server		AutoMapper [MIT] Swashbuggle [MIT] SqlKata [MIT] Dapper [Apache 2.0] Serilog [Apache 2.0] xunit [Apache 2.0]
PayrollEngine.PayrollConsole.git	Payroll console application		NPOI [Apache 2.0] Serilog [Apache 2.0]
PayrollEngine.WebApp.git	Payroll Web application		MudBlazor [MIT] LocalStorage [MIT] Serilog [Apache 2.0]

¹⁾ Loggers can be integrated through the PayrollEngine.ILogger interface.
²⁾ Report and document generator can be integrated through the PayrollEngine.Document.IDataMerge interface.
³⁾ Static HTML documentation.
⁵⁾ NuGet entry package.

NuGet Packages

By referencing the NuGet package PayrollEngine.Client.Services, the engine can be included in .NET clients. The reference of the NuGet package is

<PackageReference Include="PayrollEngine.Client.Services" Version="0.6.0-beta.4" />

Developer Reference Manual

For the development of payroll client applications and regulations scripts, the following reference manuals are available to the developer:

• Services Reference - contains all classes of client services
• Script Reference - description of scripting classes

In the [Release] Assets (https://github.com/Payroll-Engine/PayrollEngine/releases) the documentation can be downloaded as a zip file. After unpacking the zip archive, index.html is the start page of the documentation.

The HTML help can also be started as a web application that supports dark mode display (see Client Scripting and Client Services).

Credits

👍 Many thanks to all who supported the open source idea. Only this way this project could be created.