Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GianlucaBessone/HDB-Service/llms.txt

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

HDB Service is an operations platform built for field service teams that manage water dispenser fleets across industrial clients. It tracks every dispenser through its full lifecycle, automates preventive maintenance schedules, enforces SLA deadlines, and gives every stakeholder — from technicians on the floor to client managers — a role-appropriate view of the fleet.

Introduction

Understand what HDB Service does and how its components fit together.

Quickstart

Clone, configure, and run your first HDB Service instance in minutes.

Roles & Permissions

Learn the five-role RBAC model and what each role can do.

API Reference

Explore every REST endpoint with parameters, payloads, and responses.

What HDB Service Covers

Dispenser Management

Track status, location history, repairs, consumables, and spare-part installations for every unit.

Ticketing

Log incidents, assign technicians, monitor SLA compliance, and notify stakeholders in real time.

Preventive Maintenance

Auto-generate monthly schedules, collect digital checklists, and capture legally-binding approval signatures.

Inventory

Manage consumables and spare parts per plant, transfer stock between locations, and track inter-plant debts.

Analytics Dashboard

Monitor MTTR, SLA compliance, dispenser health, and low-stock alerts from a single view.

Notifications

Receive push (OneSignal) and email alerts for new tickets, SLA breaches, and maintenance events.

Get Up and Running

1

Clone and install dependencies

Clone the repository and install Node.js dependencies using your preferred package manager.
2

Configure environment variables

Copy .env.example to .env.local and fill in your PostgreSQL connection string, Supabase keys, and OneSignal credentials.
3

Run database migrations and seed

Apply the Prisma schema to your PostgreSQL database and optionally seed the material catalog.
4

Start the development server

Run npm run dev and open http://localhost:3000 to access the platform.
See the Quickstart guide for the full step-by-step setup, including Supabase Auth configuration and database seeding.

Build docs developers (and LLMs) love