Quickstart

Get MLM up and running and create your first work order in minutes

Get Started with MLM

This quickstart guide will help you set up MLM locally and walk you through creating your first maintenance work request. By the end, you’ll understand the core workflow from request submission to work order completion.

Prerequisites: Make sure you have Node.js (v18 or later) and npm installed, and a Supabase account ready.

Setup in Three Steps

1. Clone and Install

   Clone the repository and install dependencies:

   git clone https://github.com/EdgarJr30/cilm_easy_mant.git
   cd cilm_easy_mant
   npm install
   

   This installs all required packages including React 19, TypeScript, Vite, and Supabase client libraries.

2. Configure Environment

   Create a .env file in the project root with your Supabase credentials:

   VITE_SUPABASE_URL=your_supabase_project_url
   VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
   

   Get these values from your Supabase project dashboard under Settings → API.

   If you want to enable push notifications, also add:

   VITE_WEB_PUSH_PUBLIC_KEY=your_vapid_public_key
   
3. Start Development Server

   Launch the application:

   npm run dev
   

   The app will be available at http://localhost:5173 (or the next available port).

   Your browser will automatically reload when you make changes to the code.

Your First Maintenance Request

Let’s walk through creating and managing a maintenance request in MLM.

1. Create a Work Request

Anyone can submit a maintenance request, even without authentication:

1. Navigate to Create Ticket

   Go to /crear-ticket or click Crear Ticket in the sidebar.

2. Fill Out the Request Form

   Provide the following information:

   • Title: Brief description (e.g., “Broken air conditioning unit”)
   • Description: Detailed information about the issue
   • Location: Select from available locations (e.g., “Adrian Tropical 27”)
   • Incident Date: When the problem occurred
   • Priority: Select priority level (Low, Medium, High)
   • Is Urgent: Mark if immediate attention is required
   • Photo: Optionally attach an image showing the issue
   • Your Name: Requester name
   • Email: Contact email
3. Submit the Request

   Click Submit to create the work request. It will appear in the Solicitudes (Work Requests) module with status pending and is_accepted: false.

2. Review and Accept Requests

Authorized users can review incoming requests:

1. Access Work Requests

   Navigate to /solicitudes (requires work_requests:read permission).

   You’ll see all pending work requests with the ability to:

   • Search by title or requester
   • Filter by location
   • Accept requests individually or in batches (up to 10)
2. Accept the Request

   Click Aceptar on a request to convert it to a work order. The is_accepted flag changes to true and it becomes visible in the Kanban board.

   Use the batch accept feature to process multiple similar requests at once.

3. Manage Work Orders on Kanban Board

Once accepted, work orders appear on the visual Kanban board:

1. Open Kanban Board

   Navigate to /ordenes_trabajo (requires work_orders:read permission).

   The board shows three default columns:

   • Pendiente (Pending)
   • En Ejecución (In Progress)
   • Finalizadas (Completed)
2. Assign and Track

   • Assign a technician: Select from available assignees
   • Set deadline: Add a due date for completion
   • Drag to update status: Move cards between columns to update progress
   • Add comments: Collaborate with your team using the comment feature
   • Upload photos: Document progress with photo attachments
3. Complete the Work Order

   Drag the card to Finalizadas when work is done. The finalized_at timestamp is automatically recorded.

   Completed work orders can be archived for historical record-keeping.

Understanding the Workflow

MLM follows a clear maintenance workflow:

Work Requests

Learn about the request submission and approval process

Work Orders

Explore work order management and tracking features

Kanban Board

Master the visual workflow management interface

Notifications

Set up real-time notifications for your team

Key Routes Reference

Here are the main application routes you’ll use:

Route	Purpose	Permission Required
/inicio	Dashboard and analytics	home:read
/crear-ticket	Create new work request	work_orders:create
/solicitudes	Review work requests	work_requests:read
/ordenes_trabajo	Kanban board for work orders	work_orders:read
/mi-perfil	View your assigned tickets	work_orders:read_own
/inventario	Inventory management	inventory:read
/admin/settings	Administration hub	Various admin permissions

The application uses role-based access control (RBAC). Routes automatically redirect to /403 if you lack the required permissions.

Next Steps

Now that you’ve created your first work order, explore these features:

Set Up Your Team

Add users and configure roles and permissions

Configure Locations

Define the facilities and locations you manage

Add Technicians

Create assignee profiles for your maintenance team

Manage Inventory

Set up parts, warehouses, and stock management

Before deploying to production, make sure you’ve completed the full installation guide including database setup and Supabase configuration.