Skip to content

A package skeleton for developing Catalyst plugins.

License

Notifications You must be signed in to change notification settings

omnia-digital/catalyst-plugin-skeleton

 
 

Repository files navigation

:package_description

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads


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!

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

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.

About

A package skeleton for developing Catalyst plugins.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 91.8%
  • JavaScript 7.9%
  • CSS 0.3%