Skip to content

Template for creating/starting new laravel packages

License

Notifications You must be signed in to change notification settings

vaugenwake/laravel-package-template

Repository files navigation

:package_description

Latest Version on Packagist GitHub Tests Action Status Total Downloads

1) manually replace :author_name, :author_username, [email protected], :vendor_name, vendor_slug, Vendor Name, :package_name, package_slug, skeleton, Skeleton, :package_description with their correct values in CHANGELOG.md, LICENSE.md, README.md, ExampleTest.php, ModelFactory.php, Skeleton.php, SkeletonCommand.php, SkeletonFacade.php, SkeletonServiceProvider.php, TestCase.php, composer.json, create_skeleton_table.php.stub and delete configure-skeleton.sh

2) You can also run ./configure-skeleton.sh to do this automatically.

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

This template is inspired by the spatie package skeleton template

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 --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-config"

This is the contents of the published config file:

return [
];

Usage

$skeleton = new VendorName\Skeleton();
echo $skeleton->helloworld();

Testing

composer test

Sniffing

composer sniff
composer sniff-fix

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

Template for creating/starting new laravel packages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published