/fork-package-skeleton-laravel

A skeleton repository for Spatie's Laravel Packages

Primary LanguagePHPMIT LicenseMIT

: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 Laravel package. 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. Have fun creating your package.
  4. If you need help creating a package, consider picking up our Laravel Package Training video course.

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

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"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag=":package_slug-views"

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.