Skip to content

Repositories

Jump to bottom
Jani Giannoudis edited this page Jul 31, 2023 · 43 revisions

Repositories

GitHub Repositories

The Payroll Engine consists of the following GitHub repositories.

Payroll Engine Repository Map

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]

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.

NuGet Packages

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" />

Developer Reference Manual

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).

Credits

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

🤝 Thank you for supporting this project with a donation.
⚡ This is a pre-relase version of the initial development, please read the restrictions.

Clone this wiki locally