Skip to content

shopperlabs/addon-skeleton

Repository files navigation

:package_description

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


This repo can be used to scaffold a Shopper addon. 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

Then run the installer:

php artisan shopper:skeleton-slug:install

It runs the migrations, creates the skeleton_snake.* permissions (granted to the administrator role), and registers SkeletonAddon in your AppServiceProvider. Re-running it is safe.

Usage

The addon ships its own admin page, sidebar entry and Livewire components. Every component can be overridden from your application:

Shopper::addons([
    (new SkeletonAddon)->usingLivewireComponents([
        'skeleton-slug.index' => \App\Livewire\CustomSkeletonIndex::class,
    ]),
]);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Skeleton addon for Shopper

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors