jackiedo/workbench

Bring workbench back to Laravel 5.

5.3.0 2017-01-18 08:24 UTC

README

Bring workbench back to Laravel 5+

Overview

Look at one of the following topics to learn more about Laravel 5 Workbench

Versions and compatibility

Each branch of Laravel 5 Workbench is similarities with each version of Laravel 5+. Example:

Branch Laravel version
5.0 5.0
5.1 5.1
5.2 5.2
5.3 5.3

In each branch we have multiple versions, tagged syntax as 5.0.*, 5.1.*, 5.2.*, 5.3.*...

Installation

You can install this package through Composer.

  • First, edit your project's composer.json file to require jackiedo/workbench:
...
"require": {
    ...
    "jackiedo/workbench": "{{laravel-version}}.*"
},

Note: {{laravel-version}} string above is main version of Laravel that you want to install Laravel Workbench on it. Example, if you want to install this package on Laravel 5.3, you have to set require is "jackiedo/workbench": "5.3.*"

  • Next step, we update Composer from the Terminal on your project source:
$ composer update
  • Once update operation completes, on the third step, we add the service provider. Open config/app.php file, and add a new item to the providers array:
...
'providers' => array(
    ...
    Jackiedo\Workbench\WorkbenchServiceProvider::class,
),
  • On the fourth step, we publish configuration file:
$ php artisan vendor:publish
  • And the final step is add autoload the workbench to your bootstrap/autoload.php file. Put this following code at the very bottom of script.
/*
|--------------------------------------------------------------------------
| Register The Workbench Loaders
|--------------------------------------------------------------------------
|
| The Laravel workbench provides a convenient place to develop packages
| when working locally. However we will need to load in the Composer
| auto-load files for the packages so that these can be used here.
|
*/

if (is_dir($workbench = __DIR__.'/../workbench'))
{
    Jackiedo\Workbench\Starter::start($workbench);
}

Usage

Now, you can use workbench commands to create your packages same as on Laravel 4.2.

Note: Before you create a package, you need to update name and email config value in your config/workbench.php file.

Creating a basic package.

$ php artisan workbench vendor/package

Creating a package with generating some scaffold resources.

$ php artisan workbench vendor/package --resources

Other documentation

For more documentation about package development, you can visit Official Laravel Documentation pages: