mypayroll
v0.0.1
Published
A comprehensive HR payroll package tailored for Malaysia, helping businesses manage payroll computation efficiently
Downloads
19
Maintainers
Readme
mypayroll
mypayroll the prefix my
for stands Malaysia
mypayroll is a comprehensive HR payroll calculation package tailored for Malaysia, designed to help businesses efficiently manage payroll computations.
this project built using typescript and bun.
//example of how to use the package
import Employee from "mypayroll";
import { MartialStatus } from "mypayroll";
const testEmployee = new Employee({
name: "testEmployee",
birthDate: "11/04/1997",
martialStatus: MartialStatus.Married,
basicSalary: { amount: 3675 },
zakat: {
state: 9,
customAmount: 75,
},
});
testEmployee.printPayslip();
Table of Contents
Features
- Payroll Computation: Perform efficient payroll calculations, including EPF, KWSP, SOCSO, PERKESO, and more.
- Localization: Tailored for the Malaysian market, ensuring compliance with local regulations.
- Linting: Enforce code quality and style using ESLint.
Installation
Clone the repository:
git clone https://github.com/yourusername/mypayroll.git cd mypayroll
Install the dependencies: you can use npm or yarn whatever package manager just replace
bun
with npm or yarn in this project we usebun
bun install
if haven't install bun yet, install it first
curl -fsSL https://bun.sh/install | bash
Run the project:
dev
Code Quality
bun lint:fix
License This project is licensed under the MIT License. See the LICENSE file for details.
Author Nordin Bin Zahari GitHub: github.com/nordinz7