README

Core functionality for the Humano CRM system. This package provides the foundational framework including user management, teams, authentication, categories, and the modular system architecture.

Features

• User & Team Management: Built on Laravel Jetstream with team switching capabilities
• Authentication: Complete authentication system with permissions via Spatie Permission
• Modular System: Base architecture for adding CRM, Billing, Communications, and Hosting modules
• Categories: Flexible categorization system for organizing data across modules
• Notes: Polymorphic notes system that can be attached to any model
• Activity Logging: Comprehensive activity tracking via Spatie ActivityLog
• Dashboard: Analytics dashboard with team statistics and module status
• UI Framework: Based on Vuexy template with Livewire 3 integration

Installation

Install the package via Composer:

composer require idoneo/humano-core

Publish and run the migrations:

php artisan vendor:publish --tag="humano-core-migrations"
php artisan migrate

Publish the config file (optional):

php artisan vendor:publish --tag="humano-core-config"

Install the core system:

php artisan humano:install

Usage

Basic Setup

After installation, the package provides:

• Dashboard at /dashboard/analytics
• Category management at /categories
• Team settings and management
• User authentication via Jetstream

Module System

The core package includes a module management system. Other Humano packages register themselves automatically:

// Automatically registered by other Humano packages
$modules = \Idoneo\HumanoCore\Models\Module::active()->get();

Categories

Create categories for organizing data across modules:

use Idoneo\HumanoCore\Models\Category;

$category = Category::create([
    'name' => 'Important Contacts',
    'description' => 'High priority contacts',
    'module_key' => 'crm',
    'color' => '#dc3545',
    'icon' => 'ti ti-star',
    'team_id' => auth()->user()->currentTeam->id,
]);

Notes System

Add notes to any model using the polymorphic relationship:

use Idoneo\HumanoCore\Models\Note;

// Add note to any model
$contact = Contact::find(1);
$note = $contact->notes()->create([
    'content' => 'Important follow-up needed',
    'user_id' => auth()->id(),
    'team_id' => auth()->user()->currentTeam->id,
]);

Installation Command

Install additional modules selectively:

# Install specific modules
php artisan humano:install --modules=crm,billing

# Interactive installation
php artisan humano:install

Configuration

The config file allows customization of:

return [
    'dashboard' => [
        'default_route' => 'dashboard.analytics',
        'show_analytics' => true,
    ],
    'teams' => [
        'allow_team_creation' => true,
        'max_teams_per_user' => 5,
    ],
    'modules' => [
        'enabled_modules' => ['crm', 'billing', 'communications', 'hosting'],
    ],
];

Related Packages

• idoneo/humano-crm: Contact and project management
• idoneo/humano-billing: Invoicing and payment processing
• idoneo/humano-communications: Email, chat, and notifications
• idoneo/humano-hosting: Server and domain management

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Diego Mascarenhas
• All Contributors

License

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