A convenient way to initialize your project.

Introduction

This package adds app:install and app:update artisan commands, which runs predefined actions depending on the current environment to initialize your application. We all know that we have to document the installation process of the application in each project, and we also always write deploy scripts in Forge, Envoy.blade.php, bash scripts etc. With Initializer you have an ability to define these processes directly in application by simple commands chain and totally simplify your deploy script.

Installation

Via Composer

composer require mad-web/laravel-initializer

then run:

php artisan make:initializers

It create Install and Update classes in app directory which contains local and production methods according to different environments. This methods should return runner chain with specific to install or update actions.

You can override config key which stores current environment value, publish config file and set env_config_key value.

php artisan vendor:publish --provider="MadWeb\Initializer\InitializerServiceProvider" --tag=config

by default value is set to app.env for laravel, in most cases you don't need to override this value.

Usage

Usage of app:install and app:update command are the same except that app:install uses Install class and app:update uses Update class.

Install class contents:

namespace App;

use MadWeb\Initializer\Contracts\Runner;

class Install
{
    public function production(Runner $run)
    {
        return $run
            ->artisan('key:generate')
            ->artisan('migrate')
            ->external('npm', 'install', '--production')
            ->external('npm', 'run', 'production')
            ->artisan('route:cache')
            ->artisan('config:cache')
            ->external('composer', 'dump-autoload', '--optimize');
    }

    public function local(Runner $run)
    {
        return $run
            ->artisan('key:generate')
            ->artisan('migrate')
            ->external('npm', 'install')
            ->external('npm', 'run', 'development');
    }
}

You can add any another method which should be called the same as your environment name, for example staging, and define different commands.

If you need to run commands with root privileges separately, you can define a method according to the following convention.

namespace App;

use MadWeb\Initializer\Contracts\Runner;
use MadWeb\Initializer\Jobs\Supervisor\MakeQueueSupervisorConfig;
use MadWeb\Initializer\Jobs\Supervisor\MakeSocketSupervisorConfig;

class Install
{
    public function local(Runner $run)
    {
        return $run
            ->artisan('key:generate')
            ->artisan('migrate')
            ->external('npm', 'install')
            ->external('npm', 'run', 'development');
    }

    public function localRoot(Runner $run)
    {
        return $run
            ->dispatch(new MakeQueueSupervisorConfig)
            ->dispatch(new MakeSocketSupervisorConfig)
            ->external('supervisorctl', 'reread')
            ->external('supervisorctl', 'update');
    }
}

Run it by passing "root" option:

artisan app:install --root

If you want to move config classes from the app directory to a different place, just rebind project.installer and project.updater keys in the AppServiceProvider.

$this->app->bind('project.installer', \AnotherNameSpace\Install::class);
$this->app->bind('project.updater', \AnotherNameSpace\Update::class);

Runner API (available actions to run)

$run
    ->artisan('command', ['argument' => 'argument_value', '-param' => 'param_value', '--option' => 'option_value', ...]) // Artisan command
    ->external('command', 'argument', '-param', 'param_value', '--option=option_value', ...) // Any external command by array
    ->external('command argument -param param_value --option=option_value') // Any external command by string
    ->callable(function ($arg) {}, $arg) // Callable function (like for call_user_func)
    ->dispatch(new JobClass) // Dispatch job task
    ->dispatchNow(new JobClass) // Dispatch job task without queue
    ->publish(ServiceProvider::class) // Publish single service provider assets
    ->publish([
        ServiceProvider::class,
        AnotherServiceProvider::class,
    ]) // Publish multiple packages assets
    ->publish([ServiceProvider::class => 'public']) // Publish package assets with tag
    ->publish([ServiceProvider::class => ['public', 'assets']]) // Publish package assets with multiple tags
    ->publishForce(ServiceProvider::class) // Force publish, works in any variations
    ->publishTag('public') // Publish specific tag
    ->publishTag(['public', 'assets']) // Publish multiple tags
    ->publishTagForce('public') // Force publish tags

Useful jobs

Laravel initializer provides some useful jobs to make initializing of your application much easier.

Create cron task for scheduling tasks

To enable Laravel Scheduling add dispatch MakeCronTask job to runner chain to create cron task for your application.

$run
    ...
    ->dispatch(new \MadWeb\Initializer\Jobs\MakeCronTask)

This job will add

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

to crontab list.

Create laravel-echo-server.json config file

If you use Laravel Echo Server for broadcasting events in your application, add dispatch MakeEchoServerConfig job to runner chain to create configuration file for laravel-echo-server.

$run
    ...
    ->dispatch(new \MadWeb\Initializer\Jobs\MakeEchoServerConfig);

It will create configuration file with default options of laravel-echo-server and prefilled values from your laravel application configuration.

You can override default value by passing array into the job constructor. It would be a good practice to create additional config value for laravel-echo-server in broadcasting.php config:

/*
|--------------------------------------------------------------------------
| Laravel Echo server configurations
|--------------------------------------------------------------------------
|
| Here you may define all of laravel echo server options
|
*/
'server' => [
    'authEndpoint' => '/broadcasting/auth',
    'port' => env('SOCKET_PORT', '6001'),
    'sslCertPath' => env('SSL_CERT', ''),
    'sslKeyPath' => env('SSL_PATH', '')
],

And pass these values to MakeEchoServerConfig job constructor.

$run
    ...
    ->dispatch(new \MadWeb\Initializer\Jobs\MakeEchoServerConfig(config('broadcasting.server')));

Create supervisor config file for queues

This job creates supervisor config file for queue workers. Just add dispatch MakeQueueSupervisorConfig job to runner chain.

$run
    ...
    ->dispatch(new \MadWeb\Initializer\Jobs\Supervisor\MakeQueueSupervisorConfig);

This job creates configuration file with the command php artisan queue:work --sleep=3 --tries=3 in /etc/supervisor/conf.d/ folder by default, with a filename according to this convention your-application-name-queue.conf.

If you want to override default options, pass it into job constructor. For example if you want to use Laravel Horizon instead of default queue workers.

$run
    ...
    ->dispatch(new \MadWeb\Initializer\Jobs\Supervisor\MakeQueueSupervisorConfig([
        'command' => 'php artisan horizon',
    ]));

Create supervisor config file for laravel echo server

On the same way as MakeQueueSupervisorConfig this job creates supervisor config file for launching laravel echo server. Add dispatch MakeSocketSupervisorConfig job to runner chain. The difference from MakeQueueSupervisorConfig is the command node ./node_modules/.bin/laravel-echo-server start and the config filename is your-application-name-socket.conf.

Both config files save log files to your-project-path/storage/logs.

Installation by one command

It would be nice to have ability to install an application by one command. We provide nice hack to implement this behavior.

Add project-install script into scripts section in composer.json.

scripts": {
    ...
    "project-install": [
        "@composer install",
        "@php artisan app:install"
    ],
    ...
},

Then you can run just

composer project-install

to initialize your project.

If your application has commands that requires root privileges and you use Unix based system, add the following command into your runner chain.

public function local(Runner $run)
{
    return $run
        ->artisan('key:generate')
        ->artisan('migrate')
        ->external('npm', 'install')
        ->external('npm', 'run', 'development')
        ->external('sudo', 'php', 'artisan', 'app:install', '--root');
}

public function localRoot(Runner $run)
{
    return $run
        ->dispatch(new MakeQueueSupervisorConfig)
        ->dispatch(new MakeSocketSupervisorConfig)
        ->external('supervisorctl', 'reread')
        ->external('supervisorctl', 'update');
}

Safe Update

In cases when latest changes has been pulled and some functionnality of currently not installed package uses in one of a Service Provider you will get an error. To prevent this issue you should make composer install at first, to simlify this process you are be able to define project-update script:

scripts": {
    ...
    "project-update": [
        "@composer install",
        "@php artisan app:update"
    ],
    ...
},

Then you can run:

composer project-update

Upgrading

Please see UPGRADING for details.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Mad Web
• All Contributors

License

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