bmatovu/laravel-package-boilerplate

Laravel package boilerplate.

v1.1.0 2020-06-11 06:21 UTC

This package is auto-updated.

Last update: 2024-03-29 04:05:25 UTC


README

Build Status Scrutinizer Code Quality Code Coverage StyleCI Documentation

Installation

Install via composer package manager:

composer create-project --prefer-dist bmatovu/laravel-package-boilerplate hello-world

Alternatively, generate a Github repository using the Use this template call to action button or the link below...

https://github.com/mtvbrianking/laravel-package-boilerplate/generate

Own the package

Update the composer.json file to match your credentials.

Change the namespaces to match those you're using in src.

Change the type from project to library

composer dump-autoload

Testing

We've defaulted to Orchestra's testbench

composer test

Code Style & Quality

We've added StyleCI configurations with the Laravel present to get you started.

Also added ScrutinizerCI configurations for code quality, test coverage inspection.

Locally, you can restort to PHP-CS-Fixer.

composer cs-fix

Source code documentation

You need to download Doctum for source code documentation.

composer doc

To auto deploy documentation; be sure to add a Github token for authorization.

Sharing the package

You may share your package via Packagist

Useful resources