mirror of
https://github.com/filamentphp/plugin-skeleton.git
synced 2025-12-06 13:38:53 +08:00
96 lines
3.0 KiB
Markdown
96 lines
3.0 KiB
Markdown
# :package_description
|
|
|
|
[](https://packagist.org/packages/:vendor_slug/:package_slug)
|
|
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
|
|
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
|
|
[](https://packagist.org/packages/:vendor_slug/:package_slug)
|
|
|
|
<!--delete-->
|
|
---
|
|
This repo can be used to scaffold a Filament plugin. Follow these steps to get started:
|
|
|
|
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
|
|
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
|
|
3. Make something great!
|
|
---
|
|
<!--/delete-->
|
|
|
|
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:
|
|
|
|
```bash
|
|
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](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) 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.
|
|
|
|
```css
|
|
@source '../../../../vendor/:vendor_slug/:package_slug/resources/**/*.blade.php';
|
|
```
|
|
|
|
You can publish and run the migrations with:
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag=":package_slug-migrations"
|
|
php artisan migrate
|
|
```
|
|
|
|
You can publish the config file with:
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag=":package_slug-config"
|
|
```
|
|
|
|
Optionally, you can publish the views using
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag=":package_slug-views"
|
|
```
|
|
|
|
This is the contents of the published config file:
|
|
|
|
```php
|
|
return [
|
|
];
|
|
```
|
|
|
|
## Usage
|
|
|
|
```php
|
|
$variable = new VendorName\Skeleton();
|
|
echo $variable->echoPhrase('Hello, VendorName!');
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
composer test
|
|
```
|
|
|
|
## Changelog
|
|
|
|
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
|
|
|
|
## Contributing
|
|
|
|
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
|
|
|
|
## Security Vulnerabilities
|
|
|
|
Please review [our security policy](.github/SECURITY.md) on how to report security vulnerabilities.
|
|
|
|
## Credits
|
|
|
|
- [:author_name](https://github.com/:author_username)
|
|
- [All Contributors](../../contributors)
|
|
|
|
## License
|
|
|
|
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|