rgasch/filament-extended-starter-kit

A Laravel Filament starter kit with lots of useful plugins installed.

v1.0.5 2022-12-04 23:03 UTC

This package is auto-updated.

Last update: 2024-03-05 01:36:56 UTC


README

FilamentExtendedStarterKit is a Filament distribution with lots of basic utilities and goodies pre-installed.

New Installation

composer create-project --prefer-dist Rgasch/filament-extended-starter-kit FilamentStarterKit

Install dependencies

composer update

Run migrations

php artisan migrate

Create the first/admin user:

php artisan make:filament-user

Init FilamentShield

php artisan shield:install

For the FilamentShield install, answer "yes" to all questions it asks.

In theory, that should be it. You can now go to /admin on your site and you should see the filament login screen. Log in with the user you created in step #4 above.

Installed Plugins

All relevant migrations, views and config files have been published to the main Laravel directory tree to the locations where you would expect them. If a package (such as, for exmaple, the Spatie packages) is based upon another package, the base package migrations and config files have been published as well.

Some of the above packages are self-explanatory (ie: you'll see them in the admin GUI) while others are development components which require some knowledge of the component for it to be used. Take a look a the component pages, some have docs on the component page, others on their github repo (linked from the component page).

Admin Menu

In order to achieve better menu item grouping, the admin menu is generated by the App\Providers\FilamentServiceProvider class. You can disable the use of this functionality (which will enable the default Filament menu generation) by setting the useCustomMenuGenerator config option to false in the /config/filament-extended-starter-kit.php config file.

HealthCheck

The health checks are also defined and configued in the App\Providers\FilamentServiceProvider class. The only variable which might require tuning is the "nCpuCores" variable which is used to configure CPU load and needs to know the number of CPU cores on you system in order to make this calculation correct.

ThemeColors

The filament-theme-color-switcher package allows you to easily switch theme colors. The starter pack contains a theme-colors array in the config/filament-extended-starter-kit.php config file which allows you to set colors either there directly or by setting FILAMENT_PRIMARY_COLOR and FILAMENT_SECONDARY_COLOR in your .env file.

Performance

Some people have reported slow page loading speeds. In response to this I've added a .htaccess file which defines caching directives which already helps quite a bit. If after this optimization you are still unhappy with your loading speeds, try removing the "ralphjsmit/tall-interactive" package from your composer.json file and then run "composer update" (this of course assumes that you are not using the functionality in this package).

Alternative

If you want a tweakable install script to produce a Filament instance for you, check out laravel-installer-script