README

Streamline Relationships. Supercharge Growth.

About Liberu CRM

Liberu CRM is a modern, open-source Customer Relationship Management platform built on Laravel 12, PHP 8.5, Filament 5, and Livewire 4. Designed to help businesses of every size manage contacts, track deals, automate workflows, and integrate seamlessly with the tools they already use — all from a clean, responsive interface.

Whether you are a solo freelancer managing a handful of clients or an enterprise team coordinating thousands of leads, Liberu CRM gives you a powerful, customisable foundation that you fully own and control. No vendor lock-in. No hidden costs. Just great software you can run anywhere.

Key Features

Seamless Contact & Lead Management — Capture, organise, and search contacts and leads effortlessly. Every interaction is logged and easily accessible from a single profile page.
Real-Time Livewire Interface — Powered by Livewire 4, the UI updates instantly without full page reloads, making editing contact information, notes, and activities fast and fluid.
Filament 5 Admin Panel — A beautifully crafted admin panel lets you manage users, roles, settings, and every aspect of the CRM without leaving the browser.
Advanced Workflow Automation — Build visual automation flows triggered by contact events, deal stage changes, email engagement, form submissions, date conditions, and more. Actions include sending emails/SMS, updating records, creating tasks, adding tags, and calling webhooks.
Sales Pipeline & Forecasting — Drag-and-drop pipeline boards, weighted probability scoring, historical trend analysis, and AI-powered revenue forecasting give your sales team full visibility into the pipeline.
Email Tracking & Templates — Track email opens, clicks, and bounces. Build reusable templates with a visual editor, dynamic variables, A/B testing, and version control.
Task & Activity Tracking — Create tasks, set reminders, assign them to team members, and associate them with contacts or deals. Never miss a follow-up again.
Live Chat & Chatbots — Engage visitors in real time with live chat, agent assignment, and chat ratings. Configure chatbot flows to qualify leads, answer FAQs, and schedule appointments automatically.
Advertising Account Management — Connect Google Ads, Facebook Ads, LinkedIn Ads, and Instagram Ads. View campaign metrics and tie ad performance directly to CRM data.
RESTful API — A fully versioned REST API secured with Laravel Sanctum enables custom integrations and lets you extend the CRM to fit any workflow.
OAuth 2.0 Integrations — Secure token-based authentication for MailChimp, Stripe, Google, Microsoft, Facebook, LinkedIn, Twitter, and Zoom — no hard-coded API keys required.
Advanced Reporting — A drag-and-drop report builder with custom filters, groupings, multiple chart types, scheduled delivery, CSV/PDF/Excel export, and shareable dashboards.

Our Projects

The Liberu ecosystem contains a number of companion repositories and packages that extend or demonstrate functionality used in this boilerplate.

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 different categorisation, open an issue or submit a pull request and we will update the list. Contributions and cross-repo collaboration are warmly encouraged.

Hosted Application Packages

Prefer a managed deployment? Browse our hosted application packages — fully configured instances of Liberu CRM ready to use within minutes.

Installation

Prerequisites

PHP 8.5 or higher
Composer
Node.js & npm
A supported database (MySQL, PostgreSQL, or SQLite)

Option 1 — Automated Installer (Recommended)

The quickest way to get started is to run the included installer script from the terminal:

./setup.sh

The script will:

Optionally copy .env.example to .env
Ask you to confirm your database credentials are configured
Run composer install to install PHP dependencies
Generate an application key
Run database migrations (fresh) and seed the database
Execute the test suite to verify the installation
Clear and cache all Laravel optimisations
Optionally start the development server

Note 1: The script will ask whether to overwrite an existing .env file. Answer n if you already have a configured .env.

Note 2: The script runs database seeders — make sure this is intentional before proceeding.

Graphical Installer

If you prefer a point-and-click experience, a graphical installer is also available. Download and run it from the releases page and follow the on-screen prompts — no terminal knowledge required.

Option 2 — Manual Installation

git clone https://github.com/liberu-crm/crm-laravel.git
cd crm-laravel
composer install
cp .env.example .env
php artisan key:generate
# Edit .env with your database credentials, then:
php artisan migrate --seed
npm install && npm run build
php artisan serve

Note: Ensure your .env file is correctly configured with your database connection details before running migrations.

Option 3 — Docker

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

Using Laravel Sail

./vendor/bin/sail up

Once the containers are running, open http://localhost in your browser. Press Ctrl+C to stop. See the official Sail docs for further options.

Testing

php artisan test

This will execute the full test suite, including feature tests, unit tests, and Twilio integration tests.

API

Liberu CRM exposes a fully versioned RESTful API secured with Laravel Sanctum. It supports CRUD operations for contacts, deals, and tasks and is designed for straightforward third-party integration.

See the API Documentation for endpoint reference and usage examples.

Additional Integrations

Twilio (Voice & SMS)

Add the following to your .env file and run php artisan migrate:

TWILIO_SID=your_twilio_sid
TWILIO_AUTH_TOKEN=your_twilio_auth_token
TWILIO_PHONE_NUMBER=your_twilio_phone_number
TWILIO_TWIML_APP_SID=your_twiml_app_sid
TWILIO_WEBHOOK_URL=https://your-app-url.com/twilio/webhook

Features include click-to-call, inbound call routing, automatic call logging, call recording, and call notes.

Advertising Platforms

Add API credentials for any of the supported platforms to your .env:

GOOGLE_ADS_CLIENT_ID=your_google_ads_client_id
GOOGLE_ADS_CLIENT_SECRET=your_google_ads_client_secret
GOOGLE_ADS_DEVELOPER_TOKEN=your_google_ads_developer_token

FACEBOOK_APP_ID=your_facebook_app_id
FACEBOOK_APP_SECRET=your_facebook_app_secret

LINKEDIN_CLIENT_ID=your_linkedin_client_id
LINKEDIN_CLIENT_SECRET=your_linkedin_client_secret

Then run php artisan migrate to create the required tables.

OAuth 2.0

Secure browser-based authorisation is supported for: MailChimp, Stripe Connect, Google/Gmail, Microsoft/Outlook, Facebook, LinkedIn, Twitter, and Zoom. See the OAuth Authentication Guide.

Email Tracking

Open tracking, click tracking, bounce detection, unsubscribe management, engagement scoring, and multi-device tracking. See the Email Tracking Guide.

Workflow Automation

Build advanced automations with a visual workflow builder. See the Workflow Automation Guide.

License

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

What the MIT License means for you

Free to use — use this software in any personal or commercial project at no cost.
Free to modify — adapt, extend, and customise the source code however you need.
Free to distribute — share your modifications and derivative works under the same or a compatible licence.
No warranty — the software is provided "as is", without warranty of any kind.

The permissive nature of the MIT License means there are no unnecessary restrictions on how you use or build upon Liberu CRM.

Contributing

Contributions are warmly welcome! We believe great software is built collaboratively, and every contribution — large or small — makes a difference.

How to contribute

Fork the repository and create your branch from main.
Make your changes — add features, fix bugs, improve documentation, or write tests.
Run the test suite (php artisan test) to ensure nothing is broken.
Open a Pull Request against the main branch with a clear description of what you changed and why.

Our team will review your pull request, provide feedback, and work with you to merge it as quickly as possible.

If you are not ready to submit code yet, opening an issue is equally valuable. Issues help us track bugs, prioritise features, and gather community feedback.

We are committed to maintaining an inclusive and respectful environment. All contributors are expected to follow our Code of Conduct.

Thank you for considering contributing to Liberu CRM — together we can build something great! 🚀

liberu-crm / crm-laravel

Maintainers

Package info

Fund package maintenance!

Statistics

Security