Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Paramount-Intelligence/HR_Monitoring_System/llms.txt

Use this file to discover all available pages before exploring further.

The Workforce Intelligence & Execution OS is an internal workforce operations platform built by Paramount Intelligence. It captures employee work activity, governs project and task execution, and surfaces operational data as actionable performance insights — giving Admins, Managers, and Employees a single system of record for daily work.

Introduction

Understand what the platform does and who it’s for

Quickstart

Run the full stack locally in minutes

API Reference

Explore every REST endpoint with request and response schemas

Roles & Permissions

Learn how RBAC controls access across the platform

Core Modules

Attendance & Shifts

Check-in/out, break tracking, and session classification

Leave & WFH

Submit and approve leave, WFH, and half-day requests

Projects & Tasks

Project approval workflows and full task lifecycle management

Time Tracking

Live timers and manual time log entries per task

Analytics & Reports

Role-specific dashboards with KPI cards and trend charts

Communication

Messaging, WebRTC calls, meetings, and push notifications

Get Running in 4 Steps

1

Clone and configure environment

Copy .env.example to .env at the repo root and set APP_SECRET_KEY, DATABASE_URL, and REDIS_URL.
2

Install backend dependencies and run migrations

Create a Python virtual environment in apps/api, install requirements, then run alembic upgrade head to prepare the database.
3

Install frontend dependencies

From the repo root, run npm install to install all workspace packages including the Next.js web app.
4

Start all services

Launch the FastAPI backend on port 8080, the Celery worker (requires Redis), and the Next.js frontend on port 3000.
See the Local Development guide for complete setup instructions including database seeding and default admin credentials.

Build docs developers (and LLMs) love