Quick Links

Truest HRIS Documentation

Complete guide to installing, configuring, and using Truest HRIS

Installation

Get started with Truest HRIS in just a few steps.

Requirements

  • PHP 8.1 or higher
  • MySQL 5.7+ or PostgreSQL 10+
  • Composer
  • Node.js & NPM

Clone Repository

git clone https://github.com/yourusername/truest-hris.git
cd truest-hris

Install Dependencies

composer install
npm install

Environment Setup

cp .env.example .env
php artisan key:generate

Configuration

Configure your database and other settings in the .env file.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=truest_hris
DB_USERNAME=root
DB_PASSWORD=

Run Migrations

php artisan migrate --seed

Usage

Start the development server and access the application.

php artisan serve

Visit http://localhost:8000 in your browser.

API Reference

Truest HRIS provides a RESTful API for integration.

Base URL: https://your-domain.com/api

Endpoints

  • GET /api/employees - List all employees
  • POST /api/employees - Create new employee
  • GET /api/attendance - Get attendance records
  • POST /api/leave - Submit leave request

Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Need help or have questions?

Join the Discussion