HRMS Documentation

Complete HR Management System with Advanced Features

Version 1.0.0 Laravel 10 MySQL Bootstrap 5
Documentation

Item Overview

Clean Code

Well-structured & documented code following Laravel best practices

Responsive Design

Works perfectly on all devices and screen sizes

Secure System

Built with security best practices and data protection

Quick Start

This documentation will help you get started with the HRMS system. Please read carefully before installation.

Item Details
  • Version: 1.0.0
  • Released: July 10, 2025
  • Last Update: July 10, 2025
  • Framework: Laravel 10.x
  • Author: Prajwal Rai
  • License: Regular License
  • Documentation: Well Documented
  • Support: 1 month included

Features List

Organization Structure
  • Departments
  • Job Positions
  • Branch Offices
Master Settings
  • Employment Types
  • Leave Categories
  • Holiday Calendar
Payroll Configuration
  • Allowances & Deductions
  • Work Shifts
  • Tax Configuration
  • Unit Settings
Workforce Management
  • System Users & Roles
  • Employee Records
Payroll Management
  • Pay Scale Setup
  • Generate Payslips
  • All Payslips
Attendance Management
  • Daily Attendance
  • Attendance Reports
Leave & Resignation
  • Leave Management
  • Resignation
  • Reimbursement
Performance & Work
  • Performance Reviews
  • Performance Reports
  • Assign Work & Work Status
  • Employee Reports
Recruitment
  • Jobs & Candidates
  • Assessments & Questions
Letters & Documents
  • Offer Letters
  • Other Official Letters
  • Document Management
Certificate Management
  • Generate Certificates
  • All Certificates
System Settings
  • Company Profile
  • General Settings
  • Panel Settings
  • Integration Settings
  • Privacy Policy & Terms
  • SEO Management
Quote Management
  • Create Quotes
  • All Quotes
Communication Hub
  • One to One Chat
  • Team Communication
Logs & Activity
  • Activity Logs
  • Approval Center

Requirements

Server Requirements
  • PHP >= 8.1
  • MySQL 5.7+ or MariaDB 10.3+
  • Apache/Nginx Web Server
  • SSL Certificate (Recommended)
Required Extensions
  • BCMath PHP Extension
  • Ctype PHP Extension
  • JSON PHP Extension
  • Fileinfo PHP Extension
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

Installation

Before Installation

Make sure your server meets all the requirements listed above.

Step 1: File Upload
  1. Extract the downloaded zip file
  2. Upload the contents to your web server
  3. Set proper permissions (755 for directories, 644 for files)
Step 2: Database Setup
  1. Create a new MySQL database
  2. Import the provided SQL file from the 'database' folder
  3. Configure database connection in .env file
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=your_username
DB_PASSWORD=your_password
Step 3: Environment Setup
  1. Rename .env.example to .env
  2. Update application URL
  3. Configure mail settings
APP_URL=http://your-domain.com
MAIL_MAILER=smtp
MAIL_HOST=your-smtp-host
MAIL_PORT=587
MAIL_USERNAME=your-username
MAIL_PASSWORD=your-password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=your-email

Configuration

System Settings

Access the admin panel using default credentials:

  • URL: your-domain.com/login
  • Email: admin@hrmatrixpro.com
  • Password: admin123
Change default credentials immediately after first login!
Company Settings

Configure your company details in Settings → Company Profile && General Settings && Panel Settings:

  • Company Information
  • Logo & Branding
  • Signature & Stamp
  • Company Invoice & Tax Settings
  • Currency Setup
  • Privacy Policy & Terms & Conditions
  • SEO Management

Admin Guide

Admin Access

Access the admin panel at: your-domain.com/login
Default credentials: admin@hrmatrixpro.com / admin123

Total Employees

Shows the total number of employees in the system.

Today's Attendance

Displays present employees out of the total for today.

On Leave Today

Number of employees currently on leave.

Monthly Payroll

Total payroll processed for the current month.

Monthly Attendance Overview

Interactive chart showing attendance trends for the month.

Leave Application Distribution

Visualizes leave requests and their approval status.

Follow-up & Interview Pipeline

Charts for follow-up and interview progress tracking.

Document Requests

Timeline of pending requests for experience letters, salary certificates, and other documents.

Performance Overview

Chart and average rating for employee performance.

Department & Designation Performance

Charts showing performance by department and designation.

Tip: The dashboard also provides quick links to leave requests, approvals, and other HR actions for efficient management.

Setting Up Your Organization:
1. Departments
  1. Go to Organization Structure → Departments
  2. Click "Add Department"
  3. Enter department name and description
  4. Set department head (optional)
  5. Save the department
2. Job Positions
  1. Navigate to Organization Structure → Job Positions
  2. Click "Add Job Position"
  3. Enter position title and description
  4. Set reporting hierarchy
  5. Define position requirements
3. Branch Offices
  1. Go to Organization Structure → Branch Offices
  2. Click "Add Branch"
  3. Enter branch name, address, and contact details
  4. Set branch manager
  5. Configure branch-specific settings

Essential System Settings:
1. Employment Types
  1. Go to Master Settings → Employment Types
  2. Add types like: Full-time, Part-time, Contract, Intern, etc.
2. Leave Categories
  1. Navigate to Master Settings → Leave Categories
  2. Create categories: Annual Leave, Sick Leave, Personal Leave, etc.
3. Holiday Calendar
  1. Go to Master Settings → Holiday Calendar
  2. Add company holidays

Setting Up Payroll System:
1. Allowances & Deductions
  1. Go to Payroll Configuration → Allowances & Deductions
  2. Add allowances: Housing, Transport, Meal, etc.
  3. Set up deductions: Tax, Insurance, Loans, etc.
2. Work Shifts
  1. Navigate to Payroll Configuration → Work Shifts
  2. Create shifts: Morning, Evening, Night, Flexible Shift, etc.
  3. Set shift timings and break periods
3. Tax Configuration
  1. Go to Payroll Configuration → Tax Configuration
  2. Set up tax brackets and rates
4. Unit Settings
  1. Navigate to Payroll Configuration → Unit Settings
  2. Create units name and value

Managing Employees and Users:
1. System Users
  1. Go to Workforce Management → System Users
  2. Click "Create User"
  3. Enter user details: name, email, role
  4. Configure user status (active/inactive)
2. Employee Records
  1. Navigate to Workforce Management → Employee Records
  2. Click "Add Employee"
  3. Fill in personal information
  4. Set employment details (department, position, salary, etc.)
  5. Upload required documents

Processing Payroll:
1. PayScale Setup
  1. Go to Payroll Management → PayScale Setup
  2. Configure PayScale Setup
2. Generate Payslips
  1. Go to Payroll Management → Generate PaySlips
  2. Choose employees or select all
  3. Select Salary Type
  4. Select Payroll Period (month/year)
  5. Generate Payslips
  6. Review and approve Payslips (optional)
3. All PaySlips
  1. Navigate to Payroll Management → All PaySlips
  2. View all generated payslips
  3. Filter by date, employee, or status
  4. Download payslips in PDF format

Managing Employee Attendance:
1. Daily Attendance
  1. Go to Attendance Management → Daily Attendance
  2. View daily attendance records
2. Attendance Reports
  1. Navigate to Attendance Management → Attendance Reports
  2. Generate reports by date range
  3. Filter by employee, or date
  4. Analyze attendance patterns and trends

Managing Employee Leave & Resignation:
1. Resignation Requests
  1. Go to Leave Management → Resignation
  2. View resignation requests
  3. Approve or reject or delete resignation requests
2. Leave Requests
  1. Go to Leave Management → Leave Requests
  2. Create leave requests
  3. View leave requests
  4. Approve or reject or delete leave requests

Managing Employee Performance:
1. Performance Reviews
  1. Go to Performance Management → Performances
  2. View performance reviews
  3. Filter by employee, or date or department or shift
  4. Provide the performance score.
2. Performance Reports
  1. Navigate to Performance Management → Performance Reports
  2. View performance reports
  3. Filter by employee, or date or department or shift
3. Assign Work
  1. Go to Performance Management → Assign Work
  2. Create tasks and assignments
  3. Set deadlines and priorities
  4. Assign work to employees
4. Employee Reports
  1. Navigate to Performance Management → Employee Reports
  2. View work status updates
  3. Add Daily work status
  4. View work status updates or delete

Managing Recruitment Process:
1. Jobs
  1. Go to Recruitment → Jobs
  2. Create new job postings
  3. Set job requirements and responsibilities
  4. Configure application deadlines
2. Candidates
  1. Navigate to Recruitment → Candidates
  2. Review candidate applications
  3. Shortlist candidates or delete
3. Assessments
  1. Go to Recruitment → Assessments
  2. Create assessment name
4. Questions
  1. Navigate to Recruitment → Questions
  2. Create interview questions
  3. Create Option for each question
  4. Provide the correct answer

Managing Official Documents:
1. Create Offer Letter
  1. Go to Letters & Offers → Create Offer Letter
  2. Select candidate and position
  3. Fill in offer details (salary, start date, etc.)
  4. Generate and send offer letter
2. Create Other Letters
  1. Navigate to Letters & Offers → Create Other Letters
  2. Choose letter type (Promotion, Suspension, etc.)
  3. Select employee and customize content
  4. Generate official letters
  5. Send letters to employees

System Configuration:
1. Company Profile
  1. Go to System Setup → Company Profile
  2. Update company information
  3. Upload company logo
  4. Set company address and contact details
  5. Configure company policies
2. General Settings
  1. Navigate to System Setup → General Settings
  2. Configure system preferences
  3. Set default timezone and date format
3. Panel Settings
  1. Go to System Setup → Panel Settings
  2. Configure Privacy Policy
  3. Configure Terms & Conditions
  4. Configure SEO Settings

Managing Approvals:
1. Reimbursement Approvals
  1. Go to Approval Center
  2. Review pending reimbursement requests
  3. Approve or reject with comments
2. Loan Approvals
  1. Review loan applications
  2. Verify eligibility and amounts
  3. Approve or reject applications
3. Leave Approvals
  1. Review leave requests
  2. Approve or reject applications
4. Resignation Approvals
  1. Review resignation requests
  2. Approve or reject applications

User Guide

Employee Access

Access your employee dashboard at: your-domain.com/login
Select Employee and use your company email and password to login.

Dashboard Features:
  • Personalized Welcome: Greets the employee by name, shows the current date, and a time-based greeting.
  • Today's Attendance Status: Displays whether you are present, absent, or on leave for the day.
  • Check-In/Check-Out: Allows you to check in or out, shows your check-in/check-out times, and calculates your total working time for the day.
  • Monthly Overview: Visual summary of your monthly attendance, absences, and leaves with statistics cards and charts.
  • Quote of the Day: Motivational or inspirational quote displayed daily.
  • Notice Board: Lists unread notifications and important updates from HR or management.
  • Responsive Design: Optimized for both desktop and mobile devices, with a modern, clean look and dark mode support.

Managing Your Attendance:
1. Attendance Log
  1. Go to Time & Attendance → Attendance Log
  2. View your daily attendance records
  3. Check your attendance history
2. Leave Management
  1. Navigate to Time & Attendance → Leave Management
  2. Click "Apply for Leave"
  3. Select leave type (Annual, Sick, Personal)
  4. Choose start and end dates
  5. Add reason for leave
  6. Submit your application
3. Holiday Calendar
  1. Go to Time & Attendance → Holiday Calendar
  2. View upcoming company holidays
  3. Plan your leave around holidays

Managing Your Finances:
1. Salary Slips
  1. Go to Finance & Benefits → Salary Slips
  2. View your monthly payslips
  3. Download payslips in PDF format
2. Reimbursements
  1. Navigate to Finance & Benefits → Reimbursements
  2. Click "Apply for Reimbursement"
  3. Enter expense amount and description
  4. Upload receipts and supporting documents
  5. Submit your claim
  6. Track claim status
3. Loan Requests
  1. Go to Finance & Benefits → Loan Requests
  2. Click "Apply for Loan"
  3. Choose repayment period
  4. Provide reason for loan
  5. Submit application
  6. Track application status

Managing Your Career:
1. Performance Review
  1. Go to Career & Performance → Performance Review
  2. View your performance assessments
  3. Review feedback from managers
2. Resignation Portal
  1. Navigate to Career & Performance → Resignation Portal
  2. Click "Submit Resignation"
  3. Select resignation date
  4. Provide resignation reason
  5. Upload resignation letter
  6. Submit your resignation
  7. Track resignation status

Managing Your Work:
1. Assigned Tasks
  1. Go to Work Management → Assigned Tasks
  2. View tasks assigned to you
  3. Check task deadlines and priorities
  4. Update task progress
2. Work Status Updates
  1. Navigate to Work Management → Work Status Updates
  2. Update your work progress
  3. Add status comments and notes
  4. Upload work deliverables

Managing Your Documents:
1. Official Letters
  1. Go to Documents & Records → Official Letters
  2. View letters sent to you
  3. Download official documents

Communication Hub:
  • View and chat with admin user

System Updates

Manual Update Process
Important: Before Updating

Always perform these safety steps before starting the update:

  • Create a complete backup of your database
  • Backup your entire project folder
  • Note down any custom changes you've made
Step-by-Step Update Process:
1. Backup Your Files

Backup these important files and folders:

  • .env file - Contains your configuration
  • public/uploads folder - Contains user uploads
  • public/images folder - Contains your custom images
  • Database backup - Use phpMyAdmin or command line
2. Download & Extract Update
  1. Download the latest version from CodeCanyon
  2. Extract the downloaded zip file
  3. Prepare the update files
3. Update Process
  1. Replace all files EXCEPT:
    • .env file
    • public/uploads folder
    • public/images folder
    • Any custom modified files
  2. Update your .env file with any new variables (check .env.example)
4. Database Update

Run these commands in order:

php artisan migrate --force
php artisan optimize:clear
php artisan view:clear
php artisan cache:clear
5. Final Steps
  1. Clear your browser cache
  2. Login to admin panel
  3. Test all major features
Need Help?

If you encounter any issues during the update process, please contact our support team at hrmatrixpro@gmail.com

Troubleshooting Common Issues

  1. Check storage folder permissions (should be 755)
  2. Clear all caches using artisan commands
  3. Verify .env file configuration
  4. Check PHP error logs

  1. Run all migration commands again
  2. Clear browser cache completely
  3. Verify all files were replaced correctly
  4. Check for any JavaScript console errors
Version History
Version 1.0.0 - March 15, 2024
Current Version
  • Initial release
  • Complete HR management features
  • Employee management system
  • Attendance and leave management
  • Payroll system
  • Performance management

Frequently Asked Questions

To update the system:

  1. Download the latest version
  2. Back up your database and files
  3. Replace the files with new version
  4. Run database migrations

You receive a downloadable ZIP file containing the full source code, documentation, and installation instructions. You also get access to free updates and 1 month of support from the author.

Support is provided via the CodeCanyon support tab or the contact details in the documentation. You can ask about installation, bugs, and general usage. Customization and installation services may require an additional fee.

Each purchase is valid for a single end product. If you want to use the theme for multiple projects, you need to purchase additional licenses as per CodeCanyon's licensing policy.

Download the latest version from your CodeCanyon account, back up your files and database, and follow the update instructions in the documentation. Always test updates on a staging environment before applying to production.

Refunds are handled by Envato/CodeCanyon and are subject to their refund policy. Generally, refunds are only granted if the item is broken, not as described, or not working as intended.

Support

Email Support

For technical issues and queries:

hrmatrixpro@gmail.com

Response within 24-48 hours

Support Policy

Support is included for 1 month from the purchase date. This includes:

  • Bug fixes
  • Technical queries
  • Installation support
  • Feature clarifications