Skip to content

Commit 0850433

Browse files
docs: add professional README for payroll system
Added a comprehensive README file to document the Payroll Management System. This includes project overview, features like real-time search and mobile responsiveness, and technology stack (HTML/CSS/JS).
1 parent 4aba80f commit 0850433

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# 📑 Payroll Management System
2+
3+
![Project Status](https://img.shields.io/badge/STATUS-ACTIVE-brightgreen?style=for-the-badge) ![License](https://img.shields.io/badge/LICENSE-MIT-blue?style=for-the-badge)
4+
5+
---
6+
7+
## 📖 About the Project
8+
9+
The **Payroll Management System** is a specialized web tool developed to streamline the financial closing of construction projects. It replaces manual calculations with a dynamic interface for tracking workdays and monthly remunerations.
10+
11+
Built specifically for the **civil construction sector**, the system focuses on:
12+
13+
1. **Closing payrolls** for specific months (e.g., January 2026).
14+
2. **Managing diverse roles**, from bricklayers and carpenters to helpers.
15+
3. **Automating salary calculations** based on days worked.
16+
4. **Providing instant data access** through an advanced filtering engine.
17+
18+
---
19+
20+
## 🚀 Features
21+
22+
- 🔍 **Multi-field Search**: Filter the entire database by name, role, workdays, or salary.
23+
- 📱 **Mobile-First Responsiveness**: Fully optimized layout for tablets and smartphones used on-site.
24+
-**Dynamic Rendering**: Real-time table updates using optimized JavaScript array manipulation.
25+
- 💰 **Currency Formatting**: Automatic Brazilian Real (R$) formatting for financial precision.
26+
- 🏗️ **Industry-specific UI**: Clean, high-contrast design with visual priority on relevant field data.
27+
28+
---
29+
30+
## 🛠️ Technologies Used
31+
32+
![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) ![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white) ![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black) ![Git](https://img.shields.io/badge/GIT-E44C30?style=for-the-badge&logo=git&logoColor=white)
33+
34+
---
35+
36+
## 📱 How to Use
37+
38+
1 **Access the Live Version:** [Click here to view the Dashboard](https://marcossoftwareengineering.github.io/Payroll/)
39+
2. **Dynamic Search**: Start typing any detail in the search bar to see the table update instantly.
40+
3. **Mobile Experience**: On small screens, rows transform into vertical cards for better readability.
41+
42+
---
43+
44+
## 📂 Project Structure
45+
46+
1. **index.html** → Application skeleton with semantic tags.
47+
2. **style.css** → Custom styling, media queries, and layout rules.
48+
3. **index.js** → Core logic for data filtering and DOM manipulation.
49+
4. **README.md** → Technical documentation.
50+
51+
---
52+
53+
## 👷 Author
54+
55+
**Marcos Vinicius** Software Engineering Student & Civil Construction Intern
56+
57+
*Bridging the gap between Construction Management and Software Solutions.* [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/marcos-vinicius-souza-silva-29025a294)

0 commit comments

Comments
 (0)