Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 2.63 KB

README.md

File metadata and controls

72 lines (50 loc) · 2.63 KB

: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. Unless you are a member of Hexafuchs, please use the Original Template by Spatie.

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.

Installation

You can install the package via composer:

composer require hexafuchs/: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"

Documentation

You can find the entire documentation at https://hexafuchs.github.io/:package_name/.

Testing

composer test

Docs

composer run docs:install  # only required on first run
composer run docs

Changelog

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

License

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