Payroll Processor

Sample HRIS application where a list of employees and their payroll information would be available in report format.

Status of this Repository

This project was started as an exploration into various technologies and approaches that the contributors had been meaning to try but weren't able to exercise in their employer's production code. The effort and success this project achieved was a labor of love and will forever hold fond memories in my (@KyleMcMaster's) heart as a catalyst for learning and growth that had an impactful experience on my career. Since 2022 or so, development on this project has become stale and the primary contributors have all taken interest in other technologies and problems that aren't represented within the space of this sample application. You can follow my latest development efforts over at FShopOnWeb I hope this code can continue to be a reference for anyone interested in the patterns and principles applied here.

Build status

Api and Functions

Client

Motivation

This project was created to explore a variety of technologies, patterns, and frameworks in a sandbox style environment. The fictional domain of the application is designed be restrictive enough to mimic a real world application while also allowing creative and technical freedom for the developers involved.

Areas of interest:

• Functional Programming
• Automated Tests
• Basics of Angular, TypeScript, Rxjs, and Bootstrap
• Synergy that exists between Azure Functions and .NET Core Web APIs
• Event Sourcing and CQRS
• Having fun!

Roadmap

MVP

• Employee and Payroll CRUD functionality representing a simple workflow for the domain
• Administration screen for seeding data

Future Enhancements

• Analytics like payroll totals by department, risk, and time
• Integrate Cosmos Db change feed
• Handle poison queue messages
• Add helpful notifications from SignalR messages
• Configure Tye app orchestrations

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Kyle McMaster 🎨 💻 ⚠️

Sean G. Wright 🎨 💻 👀

Justin Conklin 👀 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Star History ⭐

Project Structure

api/ - .NET API and Azure Functions backend

client/ - Main view of the application built with Angular and Boostrap

vue-client/ - Alternate view of the Admin page built with Vue3 and Tailwind CSS

References

Akita-Demo

Build / Run

This project uses VS Code Multi-root Workspaces. For the best developer experience, open the workspace directly with VS Code (code payroll-processor.code-workspace) or open the root of the repository in VS Code (code .) and when prompted, open the workspace.

API

The API solution (PayrollProcessor.sln) is set up as the default solution for Omnisharp, and is loaded as soon as the VS Code workspace is opened.

All of the backend .NET code is found in the /api folder.

This solution contains 2 applications PayrollProcessor.Functions.Api and PayrollProcess.Web.Api This solution also contains multiple shared libraries and test projects.

There are VS Code tasks (Clean, Build, Test) at the solution and the individual application project level.

PayrollProcess.Web.Api

Currently there are no application secrets or app settings to customize for the Web API. However, settings for the application can be found in appsettings.Development.json and appsettings.json.

To run the Web API run the following launch configuration (Debug: Select and Start Debugging)

• API: Run and Attach (Debug)

The application will start and listen for requests on http://localhost:5000.

PayrollProcessor.Functions.Api

• Ensure the Azure Functions VS Code extension is installed.

• Run "Azure Functions: Install or Update Azure Functions Core Tools" from the command palette.

• Update Powershell security policy

• Start the Azure Storage Emulator and Azure Cosmos Db Emulator (see: Data Storage below)

• Copy

  api/PayrollProcessor.Functions.Api/local.settings.json.sample

  to

  api/PayrollProcessor.Functions.Api/local.settings.json

• F5 or run from the VS Code Debug drop down "Function: Run & Attach (Debug)"

• Optional: Run any of the following tasks (Task: Run Task)

  • Function: Test
  • Function: Build (Debug)

• Optional: Run any of the following launch configurations (Debug: Select and Start Debugging)

  • Function: Run & Attach (Debug)

The application will listen for requests on http://localhost:7071.

Angular Client

• Copy

  client/src/environments/environment.local.sample.ts

  to

  client/src/environments/environment.local.ts

• Run the "Client: Serve" VS Code task (this will install packages and start serving the app)

Data Storage

The project currently stores data in Azure Table Storage, which can be simulated locally using the Azurite.

The locally stored data can be viewed using the Azure Storage Explorer.

This project also uses the Azure Cosmos Db Emulator which can be downloaded at https://aka.ms/cosmosdb-emulator

Note: There is a Linux/MacOS emulator available as well

Data Initialization / Seeding

Create Collections / Queues

For performing any of the following operations ensure the following:

• The Azure Storage Emulator & Azure Cosmos DB Emulator are running
• The functions API project (see: PayrollProcessor.Functions.Api above) is running

To initialize the data storage structure (a few tables and a queue):

• Make a POST request to http://localhost:7071/api/resources/
• Optional: Use Create Resources request in /docs/PayrollProcessor.postman_collection.json Postman collection

The creation process will skip any resources that already exist.

Create Seed Data

There is also an endpoint to initialize randomly generated data in the data storage:

• Make a POST request to http://localhost:7071/api/resources/data
  • There are 2 optional query parameters
    • employeesCount: Sets the number of employees created by the request
    • payrollsMaxCount: Sets the maximum number of payrolls created for each employee (random value 1-max)
• Optional: Use Create Seed Data request in /docs/PayrollProcessor.postman_collection.json Postman collection

Reset Collections / Queues and Data

Finally, there's an endpoint to clear/reset all the data currently in the app. This can be useful if you are changing schemas and don't want to write migrations.

• Make a DELETE request to http://localhost:7071/api/resources
• Optional: Use Delete Resources request in /docs/PayrollProcessor.postman_collection.json Postman collection