Skip to content

Latest commit

 

History

History
130 lines (81 loc) · 3.28 KB

README.md

File metadata and controls

130 lines (81 loc) · 3.28 KB
Raw

Laravel CRM

Latest Version on Packagist Build Status StyleCI Codacy Badge Total Downloads

This package will add CRM functionality to your laravel projects.

Use Cases

  • Use as a free CRM for your business or your clients
  • Build a custom CRM for your business or your clients
  • Use as an integrated CRM for your Laravel powered business (Saas, E-commerce, etc)
  • Use as a CRM for your Laravel development business

Features

  • Sales leads management
  • Deal management
  • Contact database management
  • Users & Teams
  • Secure registration & login
  • Reset forgotten password

Installation

Step 1: Install a Laravel project if you don't have one already

https://laravel.com/docs/6.x#installation

Step 2: Make sure you have set up Laravel auth in your project

https://laravel.com/docs/6.x/authentication

Step 3: Require the package using composer:

composer require venturedrake/laravel-crm

Step 4: Run vendor publish:

php artisan vendor:publish --provider="VentureDrake\LaravelCrm\LaravelCrmServiceProvider"

Step 5: Run migrations:

php artisan migrate

Step 6: Run database seeder:

php artisan db:seed --class="VentureDrake\LaravelCrm\Database\Seeders\LaravelCrmTablesSeeder"

Step 7: Add an email address for the user who will be the crm owner in the config file:

After publishing the package assets a configuration file will be located at config/laravel-crm.php

return [
    
    'crm_owner' => 'email@domain.com',
    
    'route_prefix' => 'crm',
    
    'route_middleware' => ['web'],
    
    'db_table_prefix' => 'crm_',
    
    'encrypt_db_fields' => true,
    
];

Usage

Access the crm at http://your-project-url/crm

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Roadmap

  • Products
  • Notes
  • Tasks
  • Files / Documents
  • Calendar (Calls, Meetings, Reminders)
  • Roles / Permissions
  • Dashboard
  • Custom Fields
  • Activity Feed / Timelines
  • CSV Import / Export

Feedback

Participate in the discord community

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email andrew@venturedrake.com instead of using the issue tracker.

Credits

License

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