hr-portal-skill
Use this skill when developing, testing, debugging, or modifying code inside the HR Portal frontend (apps/hr-portal). It applies to handling HR administration tasks such as employee roster management,
SKILL.mdskills/hr-portal-skill/SKILL.md
GitHubHR Portal Development Skill
Use this skill when modifying, running, or analyzing the HR Portal frontend application.
Overview
- Location: apps/hr-portal/
- Local Port:
3003(runs onhttp://localhost:3003) - Key Target Role:
Role.HR - Authentication Entrypoint:
http://localhost:3001/auth/internal/login(MFA/TOTP required) - Related Backend Services:
hr-service(Port8086, API path/api/v1/hr/**)user-service(Port8082, API path/api/v1/users/**)notification-service(Port8090, API path/api/v1/notifications/**)
Folder Structure & Key Paths
- Layout File: layout.tsx - Configures page layout, sidebar navigation, and notification streams.
- Sub-routes (
src/app/dashboard/):attendance: Daily check-in registers, timesheet corrections, and shift planning.employees: Roster listing, contract updates, user creation and department role assignment.leaves: Dashboard for tracking company-wide leave balances, pending leave requests, and approval histories.payroll: Processing payslips, salary tier settings, tax calculations.recruitment: Hiring pipelines, open job requisitions, candidate profile trackers.
Development Workflow
How to Run Locally
To spin up the HR Portal, run the startup script:
# Run the bat script which starts docker, Maven JAR dependencies, and the dev server
.\apps\hr-portal\hrrun.bat
Credentials for Testing
- Test Email:
hr@hariventures.com - Password:
Password@123 - MFA Flow: Requires Google Authenticator MFA setup upon first login attempt.
Code Patterns & Best Practices
- Roster Modification: HR portal acts as the creator of new employee entries, publishing Kafka events (
EMPLOYEE_ONBOARDED) in the backend. When editing employee profiles, ensure correct field updates align with@hariventure/types. - Access Control: Confirm client components utilize appropriate session validation for
Role.HR.