README

Liberu Maintenance — open-source CMMS built on Laravel 12, PHP 8.5, Filament 5 and Livewire 4

Liberu Maintenance is a free, open-source Computerised Maintenance Management System (CMMS) built with Laravel 12, PHP 8.5, Filament 5 and Livewire 4. It gives engineering and facilities teams a single place to track assets, plan preventive maintenance, raise work orders, manage documents and measure performance — all through a modern, real-time web interface that requires no proprietary licenses.

Key technologies: PHP 8.5 · Laravel 12 · Filament 5 · Livewire 4 · Jetstream

Installation

Minimum requirements

PHP ^8.5
Composer
A database (MySQL, PostgreSQL, SQLite, etc.)

Option 1 — Command-line installer (recommended)

Run the bundled install.sh script from the project root. It installs dependencies, copies .env.example to .env, generates an application key, and runs the database migrations and seeders in one step:

# Unix / macOS / WSL
./install.sh

Tip: Review the .env file after the script completes and update any environment-specific values (database credentials, mail settings, etc.) before starting the application.

Option 2 — Graphical installer

A browser-based graphical installer is included. After cloning the repository, start the development server and navigate to /install in your browser to walk through the setup wizard:

php artisan serve
# then open http://localhost:8000/install

Option 3 — Manual steps

composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed

Seeders install sample data. Skip --seed if you prefer an empty database.

Docker / Local dev

Build and run the image locally:

docker build -t maintenance-laravel .
docker run -p 8000:8000 maintenance-laravel

Or use Laravel Sail for local development:

./vendor/bin/sail up

Features

Feature	Description
Asset management	Track equipment inventory, location, status and service history in one place.
Preventive maintenance scheduler	Automated daily checks with multi-stage reminders (3 days, 1 day, same day) and recurring due-date calculations.
Work orders & tasks	Create, assign and track work orders through configurable approval and completion workflows.
Document management	Centralised storage for manuals, service records and compliance documents with version control, tagging and expiry tracking (ISO 9001, OSHA, FDA and more).
Vendor & supplier management	Manage vendor contracts, SLAs and performance metrics alongside supplier and customer relationships.
Team & user management	Role-based access control powered by Laravel Jetstream Teams.
Notifications & reports	Email and in-app alerts, customisable reports and dashboards.
Custom forms	Build and attach custom data-capture forms to any work order or schedule.
IoT sensor integration	Connect condition-monitoring sensors to trigger maintenance events automatically.
Modular architecture	Clean separation of concerns makes adding new modules or third-party integrations straightforward.

The codebase uses a modular architecture to make extensions and integrations straightforward.

Documentation Management

A comprehensive system for managing maintenance documentation:

Centralized storage for manuals, service records, and compliance documents
Document versioning and history tracking
Tag-based organization and search capabilities
Compliance tracking with expiry dates and review schedules
Support for ISO 9001, OSHA, FDA, and other regulatory standards
File upload support (PDF, Word, Images)
Integration with Equipment, Work Orders, and Maintenance Schedules

See DOCUMENTATION_MANAGEMENT.md for detailed documentation.

Preventive Maintenance Scheduler

The system includes an automated scheduler for preventive maintenance:

Daily automated checks for overdue and upcoming maintenance
Multi-stage reminders (3 days, 1 day, same day before due)
Priority-based notifications with email and in-app alerts
User-friendly Filament interface for schedule management
Recurring maintenance tracking with automatic due date calculations

See Preventive Maintenance Scheduler Documentation for detailed usage instructions.

Our projects

The Liberu ecosystem contains a number of companion repositories and packages that extend or demonstrate functionality used in this boilerplate. Below is a concise, professional list of those projects with quick descriptions — follow the links to learn more or to contribute.

Project	Repository	Short description
Accounting	liberu-accounting/accounting-laravel	Accounting and invoicing features tailored for Laravel applications.
Automation	liberu-automation/automation-laravel	Automation tooling and workflow integrations for Laravel projects.
Billing	liberu-billing/billing-laravel	Subscription and billing management integrations (payments, invoices).
Boilerplate (core)	liberusoftware/boilerplate	Core starter and shared utilities used across Liberu projects.
Browser Game	liberu-browser-game/browser-game-laravel	Example Laravel-based browser game platform and mechanics.
CMS	liberu-cms/cms-laravel	Content management features and modular page administration.
Control Panel	liberu-control-panel/control-panel-laravel	Administration/control-panel components for managing services.
CRM	liberu-crm/crm-laravel	Customer relationship management features and integrations.
E‑commerce	liberu-ecommerce/ecommerce-laravel	E‑commerce storefront, product and order management.
Genealogy	liberu-genealogy/genealogy-laravel	Family tree and genealogy features built on Laravel.
Maintenance	liberu-maintenance/maintenance-laravel	Scheduling, tracking and reporting for maintenance tasks.
Real Estate	liberu-real-estate/real-estate-laravel	Property listings and real-estate management features.
Social Network	liberu-social-network/social-network-laravel	Social features, profiles, feeds and messaging for Laravel apps.

If you maintain or use one of these projects and would like a more detailed description or a different categorisation, open an issue or submit a pull request and we'll update the list. Contributions and cross-repo collaboration are warmly encouraged.

Contributing

Contributions are welcome and warmly encouraged! Here is the process:

Open an issue first for any significant change (new feature, breaking refactor, architectural change) so the maintainers can give early feedback and help you avoid wasted effort.
Fork the repository and create a descriptively named branch (feature/my-feature or fix/my-bug).
Write or update tests to cover your change. The project uses PHPUnit via php artisan test.
Make sure all existing tests pass before submitting.
Open a pull request against the main branch with a clear description of what changed and why.
A maintainer will review the PR, request changes if needed, and merge once approved.

Bug reports, documentation improvements and small fixes can be submitted as pull requests without a prior issue.

License

This project is released under the MIT License — see the LICENSE file for the full text.

What MIT means for you:

✅ Free to use — use the software in personal, commercial or enterprise projects at no cost.
✅ Free to modify — adapt the source code to your specific requirements.
✅ Free to distribute — share the software or your modified versions with others.
✅ Free to sublicense — include it in a proprietary product without being forced to open-source your own code.
ℹ️ Attribution required — keep the original copyright notice and license text in any copy or substantial portion of the software.

Being MIT-licensed means there are no usage fees, no GPL-style "copyleft" obligations and no vendor lock-in. You own the stack.

liberu-maintenance / maintenance-laravel

Maintainers

Package info

Fund package maintenance!

Statistics

Security