README

A lightweight CRM foundation for Laravel apps with first-party support for companies, contacts, leads, deals, activities, and a simple dashboard view.

Contents

• Installation
• Usage
• Testing
• Changelog
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require centrex/laravel-crm

You can publish the config file with:

php artisan vendor:publish --tag="laravel-crm-config"

This is the contents of the published config file:

return [
    'table_prefix' => 'crm_',
    'drivers' => [
        'database' => [
            'connection' => env('CRM_DB_CONNECTION', env('DB_CONNECTION', 'sqlite')),
        ],
    ],
];

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-crm-migrations"
php artisan migrate

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-crm-views"

Usage

use Centrex\Crm\Crm;

$crm = app(Crm::class);

$lead = $crm->createLead([
    'title' => 'ERP rollout for Alpine Foods',
    'source' => 'website',
    'value' => 150000,
]);

$deal = $crm->qualifyLead($lead, [
    'expected_close_date' => now()->addMonth()->toDateString(),
]);

$crm->advanceDealStage($deal, 'proposal');

$summary = $crm->getPipelineSummary();

When web routes are enabled, the package also exposes a simple /crm dashboard.

Testing

🧹 Keep a modern codebase with Pint:

composer lint

✅ Run refactors using Rector

composer refacto

⚗️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PEST

composer test:unit

🚀 Run the entire test suite:

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• rochi88
• All Contributors

License

The MIT License (MIT). Please see License File for more information.