highsolutions/laravel-environments

A Laravel package for easy management of different environments (dev, staging, production, etc.).

Laravel Environments

, _(*1)

Easy management of different environments in Laravel projects., _(*2)

, _(*3)

Installation

This package can be installed through Composer:, _(*4)

composer require highsolutions/laravel-environments

Or by adding the following line to the require section of your Laravel webapp's composer.json file:, _(*5)

    "require": {
        "HighSolutions/laravel-environments": "3.*"
    }

And run composer update to install the package., _(*6)

Then, if you are using Laravel <= 5.4, update config/app.php by adding an entry for the service provider:, _(*7)

'providers' => [
    // ...
    HighSolutions\LaravelEnvironments\EnvironmentServiceProvider::class,
];

Optionally, publish the configuration file if you want to change any defaults:, _(*8)

php artisan vendor:publish --provider="HighSolutions\LaravelEnvironments\EnvironmentServiceProvider"

This will create new file config/environments.php with few configuration options for package., _(*9)

Configuration

Usage

Create a new environment

To create a new environment, just use create method:, _(*10)

    php artisan env:create NAME_OF_ENVIRONMENT

In case that another environment exists with the same name, you can force to overwrite it with --overwrite option:, _(*11)

    php artisan env:create local --overwrite

You can use also predefined make:env method to be more consistent with other Laravel commands (--overwrite option is enabled here):, _(*12)

    php artisan make:env NAME_OF_ENVIRONMENT

Set environment as active

To copy files to main codebase, just use set method:, _(*13)

    php artisan env:set NAME_OF_ENVIRONMENT

Copy an environment

To make a duplicate of existing environment, just use copy method:, _(*14)

    php artisan env:copy NAME_OF_EXISTING_ENVIRONMENT NAME_OF_NEW_ENVIRONMENT

In case that another environment exists with the same name, you can force to overwrite it with --overwrite option:, _(*15)

    php artisan env:copy old new --overwrite

Remove an environment

To remove an environment, just use remove method:, _(*16)

    php artisan env:remove NAME_OF_ENVIRONMENT

List all environments

To see a list of all environments, just use list method:, _(*17)

    php artisan env:list

Testing

Run the tests with:, _(*18)

bash vendor/bin/phpunit, _(*19)

Changelog

3.6.0 * Laravel 12.0 support, _(*20)

3.5.0 * Laravel 11.0 support, _(*21)

3.4.0 * Laravel 10.0 support, _(*22)

3.3.0 * Laravel 9.0 support, _(*23)

3.2.0 * Laravel 8.0 support, _(*24)

3.1.0 * Laravel 7.0 support, _(*25)

3.0.0 * Laravel 5.8 and 6.0 support, _(*26)

2.2.0 * Change name of config file from config/laravel-environments.php to config/environments.php, _(*27)

2.1.0 * Removing files that are exist in base folder but not exist in environment being set to active, _(*28)

2.0.0 * Support for all Laravel 5.* versions (to-date), _(*29)

1.6.0 * Laravel 5.6 support, _(*30)

1.5.0 * Create, Copy, Remove, Set, List commands * Unit tests * Laravel 5.5 Support, _(*31)

Credits

This package is developed by HighSolutions, software house from Poland in love in Laravel., _(*32)