King Revolution HRMS
Welcome to the documentation portal for the King Revolution Human Resource Management System (HRMS).
This system helps your organization manage its workforce — companies, departments, employees, performance reviews, and workflows — all from one platform.
Who Is This For?
| Audience | What You'll Find |
|---|---|
| HR & Admin users | Step-by-step guides for managing employees, KPI cycles, probation reviews, and system settings |
| Managers & Team Leads | How to complete KPI reviews, probation evaluations, and view your team |
| Employees | How to sign in, view your profile, complete self-evaluations, and use notifications |
| Developers | Architecture, API documentation, local setup, and project structure |
Phase-1 Scope (Current)
Phase-1 delivers two core modules:
Module 1 — Employee Management
- Entity (company) and department management
- Employee records with full profile (personal, contact, qualifications, attachments)
- Reporting hierarchy
- Employee bulk import (CSV/Excel)
- Role-based access control (RBAC)
- Probation completion workflow
Module 2 — KPI Management
- KPI template creation with weighted items
- KPI cycle lifecycle (draft → published → closed)
- Department-scoped cycle publishing
- Employee evaluation workflow (self-submit → manager review → accept/dispute → finalize)
- KPI dashboard with PIP/HiPo performance flags
- Evidence uploads with audit trail
- KPI template bulk import
- Finance CSV export
Cross-Cutting Features
- Cookie-based SPA authentication (Laravel Sanctum)
- Internal notification system with email integration
- Actionable items work queue
- Notification channel settings (Admin/HR)
- CSV exports for entities, departments, and employees
What's Not Yet Implemented
The following modules are planned for future phases:
| Module | Status |
|---|---|
| Module 3 — Leave Management | Not started |
| Module 4 — Attendance Management | Not started |
These modules are out of scope for the current release. Documentation pages exist as placeholders and will be populated when development begins.
Technology Stack
| Layer | Technology |
|---|---|
| Backend | Laravel 12 (PHP 8.2+) |
| Frontend | Next.js 16, React 19, TypeScript 5 |
| Database | PostgreSQL 15+ |
| Authentication | Laravel Sanctum (cookie-based SPA) |
| Authorization | Spatie Laravel Permission |
| API Documentation | Dedoc Scramble (auto-generated) |
| UI Components | shadcn/ui + Tailwind CSS 4 |
How to Use These Docs
- New to HRMS? Start with Signing In and Dashboard.
- Setting up locally? Go to Local Setup.
- Need architecture details? See Architecture Overview.
- Looking for module details? Browse the Modules section.
- API integration? Check API Documentation.