pabloleone/artisan-ui

A GUI for Laravel Artisan

v1.2.0 2021-12-03 18:44 UTC

This package is auto-updated.

Last update: 2024-10-29 06:13:02 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require GitHub Actions codecov

A nice GUI for Laravel Artisan, ready out of the box, configurable and handy for non-CLI experienced developers.

Supported commands must be developed in a way they can be fully set up by using arguments and options to avoid CLI interactions that CANNOT be reproduced on WEB.

Commands issuing workers are not yet supported.

Installation

You can install the package via composer:

composer require pabloleone/artisan-ui

Usage

Once installed, if you are not using automatic package discovery, then you need to register the \Pabloleone\ArtisanUi\ArtisanUiServiceProvider::class service provider in your config/app.php.

Extend

Output & Description

To decorate the command output and description, publish the package configuration (php artisan vendor:publish pabloleone/artisan-ui) and add your class decorators in the specified array. Your decorators must implement the interface Pabloleone\ArtisanUi\Models\Decorators\DecoratorInterface.

Theme

You can create your own theme for Artisan UI. To do so, publish the configuration and update the theme value with the name of the new theme you created inside its folder resources/vendor/pabloleone/artisan-ui/views/themes/{YOUR_THEME}

...
    'theme' => 'YOUR_THEME',
...

Code Style

vendor/bin/php-cs-fixer fix

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email info@pabloleone.com instead of using the issue tracker.

Credits

License

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

TO DOs

Visit this Project Board to see the pending tasks for this package.