Plugin Skeleton
:package_description
#:package_description
This repo can be used to scaffold a Filament plugin. Follow these steps to get started:
- Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
- Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
- Make something great!
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
#Installation
You can install the package via composer:
composer require :vendor_slug/:package_slug
[!IMPORTANT] If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.
After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.
@source '../../../../vendor/:vendor_slug/:package_slug/resources/**/*.blade.php';
You can publish and run the migrations with:
php artisan vendor:publish --tag=":package_slug-migrations" php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag=":package_slug-config"
Optionally, you can publish the views using
php artisan vendor:publish --tag=":package_slug-views"
This is the contents of the published config file:
return [
];
#Usage
$variable = new VendorName\Skeleton(); echo $variable->echoPhrase('Hello, VendorName!');
#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
#License
The MIT License (MIT). Please see License File for more information.