Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rampop01/HR-Platform/llms.txt

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

​
Prerequisites

Before setting up HCMatrix, ensure you have the following installed:

Node.js

Version 18.0 or higher required

Package Manager

pnpm, npm, or yarn

​
Installation

1

Clone the repository

Clone the HCMatrix source code to your local machine:
git clone <repository-url>
cd hr-platform
2

Install dependencies

Install all required packages using your preferred package manager:
pnpm install
The project includes over 50 dependencies including Next.js 16, React 19, and a comprehensive set of Radix UI components.
3

Configure environment variables

Create a .env.local file in the root directory:
touch .env.local
Add the following environment variable:
.env.local
API_BASE_URL=https://apitest.hcmatrix.co
The API_BASE_URL is critical for API proxy functionality. If not set, it defaults to https://apitest.hcmatrix.co.
4

Start the development server

Run the development server:
pnpm dev
The application will be available at http://localhost:3000

​
Environment Variables

​
Required Variables

​
API_BASE_URL
string
default:"https://apitest.hcmatrix.co"
Base URL for the backend API server. All API requests are proxied through /api/proxy/ to this endpoint.Example:
API_BASE_URL=https://api.hcmatrix.co

​
Optional Variables

Currently, HCMatrix uses a minimal environment configuration. Additional variables can be added as needed for:
  • Database connections
  • Third-party service integrations
  • Feature flags
  • Analytics tracking
Environment variables prefixed with NEXT_PUBLIC_ are exposed to the browser. Use this prefix only for non-sensitive configuration.

​
TypeScript Configuration

The project uses TypeScript 5.7.3 with strict mode enabled. Key compiler options from tsconfig.json:2-30:
tsconfig.json
{
  "compilerOptions": {
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "target": "ES6",
    "skipLibCheck": true,
    "strict": true,
    "noEmit": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "bundler",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "react-jsx",
    "incremental": true,
    "paths": {
      "@/*": ["./*"]
    }
  }
}
The @/* path alias allows you to import from the root directory. For example: import { api } from '@/lib/api'

​
Next.js Configuration

The application uses Next.js 16 with App Router. Configuration from next.config.mjs:2-9:
next.config.mjs
const nextConfig = {
  typescript: {
    ignoreBuildErrors: true,
  },
  images: {
    unoptimized: true,
  },
}
TypeScript build errors are currently ignored. This is a development convenience but should be addressed before production deployment.

​
Image Optimization

Images are served unoptimized (unoptimized: true). This configuration is suitable for static exports but may impact performance in production.

​
Styling Configuration

​
Tailwind CSS

HCMatrix uses Tailwind CSS v4.2 with custom design tokens. The styling system includes:
  • CSS Variables: Theme colors defined in globals.css using OKLCH color space
  • Dark Mode: Full dark mode support with .dark class
  • Custom Radius: Border radius defined via --radius variable (0.625rem)

​
PostCSS Configuration

From postcss.config.mjs:2-6:
postcss.config.mjs
const config = {
  plugins: {
    '@tailwindcss/postcss': {},
  },
}

​
shadcn/ui Components

The project uses shadcn/ui components configured in components.json:1-21:
components.json
{
  "style": "new-york",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "css": "app/globals.css",
    "baseColor": "neutral",
    "cssVariables": true
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "ui": "@/components/ui",
    "lib": "@/lib",
    "hooks": "@/hooks"
  },
  "iconLibrary": "lucide"
}

​
Available Scripts

From package.json:5-10: 
npm run dev
# Starts Next.js development server with hot reload

​
Key Dependencies

​
Framework & Core

  • Next.js 16.1.6: React framework with App Router
  • React 19.2.4: UI library with server components
  • TypeScript 5.7.3: Type safety and developer experience

​
UI Components

  • Radix UI: 25+ accessible component primitives
  • Lucide React: Icon library
  • Tailwind CSS 4.2: Utility-first CSS framework

​
Form & Validation

  • react-hook-form 7.54.1: Form state management
  • zod 3.24.1: Schema validation
  • @hookform/resolvers 3.9.1: Form validation integration

​
Utilities

  • date-fns 4.1.0: Date manipulation
  • recharts 2.15.0: Chart visualization
  • next-themes 0.4.6: Theme management
  • sonner 1.7.1: Toast notifications

​
Troubleshooting

Change the port by running:
PORT=3001 npm run dev
Clear cache and reinstall dependencies:
rm -rf node_modules .next
npm install
Verify API_BASE_URL in .env.local is correct and the backend server is accessible.
Build errors are currently ignored in next.config.mjs. To see them:
  1. Set ignoreBuildErrors: false
  2. Run npm run build
  3. Fix reported type errors

​
Next Steps

API Integration

Learn how to configure API endpoints and authentication

Settings

Configure platform settings and preferences

Build docs developers (and LLMs) love

Get started for freeTalk to us