Skip to content

Latest commit

 

History

History
208 lines (173 loc) · 10.1 KB

README.md

File metadata and controls

208 lines (173 loc) · 10.1 KB
Raw

MERN EMPLOYEE SALARY MANAGEMENT
{ SiPeKa }

SiPeKa (Employee Payroll System) is a system used by companies to manage employee payroll processes efficiently and accurately. This system plays a key role in automating various tasks related to payroll, such as calculating payroll, processing attendance, and paying employee wages.
In SiPeKa, employee information such as personal data, position and salary level is stored centrally. Every month, the system will retrieve employee attendance data and perform salary calculations based on the available information. This includes factors such as relevant hours worked, leave, overtime and deductions.

Configuration and Setup

In order to run this project locally, simply fork and clone the repository or download as zip and unzip on your machine.

  • Open the project in your prefered code editor.
  • Go to terminal -> New terminal (If you are using VS code)
  • Split your terminal into two (run the Frontend on one terminal and the server on the other terminal)

In the first terminal

$ cd Fronted
$ npm install (to install Frontend-side dependencies)
$ npm run dev(to start the Frontend)

In the second terminal

  • Create your MySQL database, which you will use as your database
  • Supply the following credentials
#  --- .env  ---

APP_PORT =5000
SESS_SECRET =


# --- Terminal ---

$ cd Backend
$ npm install (to install Backend-side dependencies)
$ npm start (to start the Backend)

Key Features

  • Login Admin
  • Add employee
  • Edit employee
  • Remove employee
  • Add position
  • Edit position
  • Remove position
  • Display data, input attendance, edit attendance and delete employee absences
  • Employee Salary Deduction Setting
  • Display data, input salary data, edit salary data and delete employee salary data
  • Print payroll reports, absences, and payslips
  • Change admin and employee passwords
  • Login Employees/Staff
  • Print employees/staff salary reports from personal accounts
  • 404 Page and many more
  • Responsive Design

Technologies used

This project was created using the following technologies.

Frontend

  • React JS - JavaScript library that is used for building user interfaces specifically for single-page applications
  • React Hooks - For managing and centralizing application state
  • React Router Dom - To handle routing
  • Axios - For making Api calls
  • Tailwind CSS - For User Interface
  • React icons - Small library that helps you add icons to your react apps
  • Redux - Managing complex application state
  • Localforage - Saves data in the web browser asynchronously
  • React Vite - Improved website speed
  • Redux Toolkit - To facilitate the development of web applications using Redux
  • Apexcharts - An open source library used to create interactive graphics on websites or web applications
  • Match Sorter - An open source library used to create interactive graphics on websites or web applications
  • Email JS - For User Interface
  • Framer Motion - For User Interface
  • React Redux - Managing complex application state
  • React to Print - Print PDF
  • Sweet Alert2 - Create various types of pop-up alerts such as regular alerts, error alerts, success alerts, confirmation alerts, and so on.

Backend

  • Node JS -A runtime environment to help build fast server applications using JS
  • Express JS -The server for handling and routing HTTP requests
  • MySql12 - For authentication
  • Cors - Provides a Connect/Express middleware
  • Bcrypt JS - For data encryption
  • Dotenv - Zero Dependency module that loads environment variables
  • Nodemon - To monitor changes to the program code that is being developed
  • Jsonwebtoken - For authentication
  • Cookie Parser - A middleware for web frameworks
  • Sequelize - An Object-Relational Mapping (ORM) for Node.js that makes it easy to access relational databases such as MySQL, PostgreSQL, and SQLite using the JavaScript programming language.
  • Argon2 - A password-hashing function that summarizes the state of the art in the design of memory-hard functions and can be used to hash passwords for credential storage, key derivation, or other applications.
  • Connect Session Sequelize - Implement authentication for users with site applications.

Database

  • MySQL - It provides a free cloud service to store MongoDB collections.

Screenshots

img-1

img-2

img-3

img-4

img-5

img-6

img-7

img-8

img-9

img-10

img-11

img-12

img-13

img-14

img-15

img-16

img-17

Meet The Teams

Backend Developer Frontend Developer

Aldi Ramdani
Gilbert Hutapea

Author

License

MIT License

Copyright (c) 2022 Gilbert Hutapea

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.