Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erangasandaruwan/payslipcalculator
Assignment/Task - Pay Slip Calculator is a web application which can be used to generate payment details. The application contains single micro service to calculate pay details.
https://github.com/erangasandaruwan/payslipcalculator
Last synced: about 2 months ago
JSON representation
Assignment/Task - Pay Slip Calculator is a web application which can be used to generate payment details. The application contains single micro service to calculate pay details.
- Host: GitHub
- URL: https://github.com/erangasandaruwan/payslipcalculator
- Owner: erangasandaruwan
- License: mit
- Created: 2022-11-01T00:08:07.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-01T01:39:07.000Z (about 2 years ago)
- Last Synced: 2023-09-03T18:06:01.135Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 177 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pay Slip Calculator
What is Pay Slip Calculator ?
------------------------------------
Pay Slip Calculator is a web application which can be used to generate payment details. The application contains single micro service to calculate pay details.
Tech stack
------------------------------------
+ Front-end
+ **Angular** 14 with **Bootstrap**.
+ Back-end
+ .Net core 3.1 incluing **MediatR**, **Fluent validation** & **AutoMapper** with **Nlog** logging
+ **MS SQL Server** & **Entity Core**
+ **Cache in-memory** with ASP.NET Core
+ **Swagger** as the specification of th APis
+ Test
+ Unit test with **xUnit** & **Moq**
How to run the solution ?
------------------------------------
### Running the code
#### Back-end/ Microservices -
The back-end application is implemented with entity core (EF Core) and built to work with a MS SQL Server database for data/storage usage. Here, code first approach is being used and Database Migration and Seeds are available with the solution **PaySlip.DbMigration**. (_Expected to run the solution with Visual Studio_)
+ First, create an empty database with an available/ accessible MS SQL Server.
+ DB Connectivity - Update the connection string with **PaySlipDbContext** inside appsettings.json file of the solution **PaySlip.Api**.
+ Migrations - Run the command **`Update-database`** to create the tables and insert seeds with Tax Rates.
+ Run the solution from Visual Studio else deploy the solution to IIS Server (Please refer the steps here - [Publish an ASP.NET Core app to IIS](https://learn.microsoft.com/en-us/aspnet/core/tutorials/publish-to-iis?view=aspnetcore-6.0&tabs=visual-studio)).
+ Run the solution with Docker - From terminal go into src folder, Run **`docker compose up`** and Open http://localhost:5001 on the browser.
+ Swagger - Open https://localhost:5001/swagger/index.html on the browser.
#### Fron-end/ Angular App -
The angular application is a simple interface implemented to invoke the back-end API. (_Expected to run the solution with Visual Studio Code_)
+ Install angular cli running the command **`npm i @angular/cli`**
+ Run the command **`npm install`** to install/update the required packages.
+ Run the comman **`ng serve`** to run the solution and Open http://localhost:4200 on the browser.
Assumptions
------------------------------------
+ No Authentication.
+ Consistancy over performance.
+ Back-end - Tax Rates will not get frequently get updated, else it is required to re-deploy the solution.
+ Front-end - Will always depend on language/culture with US-English. Else we need to fetch Pay Period details from the a API.
Next Steps
------------------------------------
+ Back-end - Implement a distributed caching mechanism and cache expiring mechanism.
+ Front-end - Add unit tests to Front-end(Karma with Angular).
+ Front-end - Make the UI more user friendly.
+ Front-end - Implement state management using angular store, actions, reduces and effects.
