Skip to content

Repositories

Jani Giannoudis edited this page Aug 2, 2023 · 43 revisions

Repositories

GitHub Repositories

The Payroll Engine consists of the following GitHub repositories.

Payroll Engine Repository Map

Repository Content Details Third party components
PayrollEngine Main repository GitHub last commit GitHub last release GitHub size x
PayrollEngine.Core Core payroll objects GitHub last commit NuGet package GitHub size x
PayrollEngine.Serilog System logger 1) GitHub last commit NuGet package GitHub size Serilog [Apache 2.0]
PayrollEngine.Document Report generation 2) GitHub last commit NuGet package GitHub size FastReport [MIT]
NPOI [Apache 2.0]
PayrollEngine.Client.Core Client core payroll objects GitHub last commit NuGet package GitHub size x
PayrollEngine.Client.Test Client test library GitHub last commit NuGet package GitHub size x
PayrollEngine.Client.Scripting Client scripting GitHub last commit NuGet package GitHub size docfx [MIT] 3)
xunit [Apache 2.0]
PayrollEngine.Client.Services Client services 4) GitHub last commit GitHub size docfx [MIT] 3)
PayrollEngine.Backend Backend server application GitHub last commit GitHub size AutoMapper [MIT]
Swashbuggle [MIT]
SqlKata [MIT]
Dapper [Apache 2.0]
Serilog [Apache 2.0]
xunit [Apache 2.0]
PayrollEngine.PayrollConsole Console application GitHub last commit GitHub size NPOI [Apache 2.0]
Serilog [Apache 2.0]
PayrollEngine.WebApp Web application GitHub last commit GitHub size MudBlazor [MIT]
LocalStorage [MIT]
Serilog [Apache 2.0]
PayrollEngine.JsonSchemaBuilder JSON schema generator GitHub last commit GitHub size NJSonSchema [MIT]
PayrollEngine.SqlServer.DbQuery SQL Server query tool GitHub last commit GitHub size 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.

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.
Clone this wiki locally