Filament Modules

https://github.com/coolsam726/filament-modules
Admin
Filament Modules integrates the power of modular architecture into Laravel Filament, allowing...
Tokens:1,499
Snippets:29
Trust Score:8.2
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run installation command

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Execute this command to publish the configuration file and initialize the package setup.

```bash
php artisan modules:install
```

--------------------------------

### Install Filament in a Module

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new module and initialize the necessary Filament directory structure.

```bash
php artisan module:make MyModule
```

```bash
php artisan module:filament:install MyModule
```

--------------------------------

### Install the package via Composer

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Use this command to add the package to your Laravel project dependencies.

```bash
composer require coolsam/modules
```

--------------------------------

### Publish configuration file

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Manually publish the package configuration file to your project.

```bash
php artisan vendor:publish --tag="modules-config"
```

--------------------------------

### Run tests with Composer

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Executes the project's test suite using the Composer package manager.

```bash
composer test
```

--------------------------------

### Generate Filament Panels

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new panel within a module.

```bash
php artisan module:make:filament-panel
# or
php artisan module:filament:panel
php artisan module:filament:make-panel
```

--------------------------------

### Generate Filament Themes

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new theme within a module.

```bash
php artisan module:make:filament-theme
# or
php artisan module:filament:theme
php artisan module:filament:make-theme
```

--------------------------------

### Generate Filament Plugins

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new plugin within a module.

```bash
php artisan module:make:filament-plugin
# or
php artisan module:filament:plugin
php artisan module:filament:make-plugin
```

--------------------------------

### Generate Filament Resources

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new resource within a module using interactive prompts.

```bash
php artisan module:make:filament-resource
# Aliases
php artisan module:filament:resource
php artisan module:filament:make-resource
```

--------------------------------

### Generate Filament Widgets

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new widget within a module.

```bash
php artisan module:make:filament-widget
# or
php artisan module:filament:widget
php artisan module:filament:make-widget
```

--------------------------------

### Configure module autoloading

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Add the merge-plugin configuration to your composer.json to ensure modules are correctly autoloaded.

```json
"extra": {
    "laravel": {
        "dont-discover": []
    },
    "merge-plugin": {
        "include": [
            "Modules/*/composer.json"
        ]
    }
},
```

--------------------------------

### Generate Filament Pages

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new page within a module.

```bash
php artisan module:make:filament-page
# or
php artisan module:filament:page
php artisan module:filament:make-page
```

--------------------------------

### Protecting Resources with Base Classes

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Replace standard Filament base classes with these module-specific versions to enable access control features.

```php
use Coolsam\Modules\Resource;
```

```php
use Coolsam\Modules\Page;
```

```php
use Coolsam\Modules\TableWidget;
```

```php
use Coolsam\Modules\ChartWidget;
```

```php
use Coolsam\Modules\StatsOverviewWidget;
```

--------------------------------

### Generate Filament Clusters

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Commands to create a new cluster within a module.

```bash
php artisan module:make:filament-cluster
# or
php artisan module:filament:cluster
php artisan module:filament:make-cluster
```

--------------------------------

### Applying Access Control via Trait

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Use this trait within your resource or page classes to enforce access control.

```php
use CanAccessTrait;
```

--------------------------------

### Register the ModulesPlugin in Filament Panel

Source: https://github.com/coolsam726/filament-modules/blob/5.x/README.md

Register the plugin within your panel provider to enable automatic module loading and navigation integration.

```php
// e.g. in App\Providers\Filament\AdminPanelProvider.php
 
use Coolsam\Modules\ModulesPlugin;
public function panel(Panel $panel): Panel
{
    return $panel
        ...
        ->plugin(ModulesPlugin::make());
}
```
Tokens:
Raw