https://github.com/dfurnes/environmentalist
🌱 Dead-simple setup for Laravel apps.
https://github.com/dfurnes/environmentalist
Last synced: 3 months ago
JSON representation
🌱 Dead-simple setup for Laravel apps.
- Host: GitHub
- URL: https://github.com/dfurnes/environmentalist
- Owner: DFurnes
- License: mit
- Created: 2017-10-23T04:00:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-15T15:19:16.000Z (almost 4 years ago)
- Last Synced: 2024-12-29T17:49:53.748Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 17.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Environmentalist [](https://packagist.org/packages/DFurnes/environmentalist)
**Dead-simple setup for Laravel apps.** Environmentalist is a collection of handy tools for making setup scripts with [Artisan](https://laravel.com/docs/5.5/artisan). Easily create an environment file, prompt the user for values (with smart defaults & autocomplete), and run commands - all without needing to write out or follow lengthy directions.
### Installation
To install this package simply add it to your Laravel project using composer:
```shell
$ composer require dfurnes/environmentalist
```
### Usage
Environmentalist is essentially a [PHP trait](https://www.php.net/manual/en/language.oop5.traits.php) that provides a collection of helpful methods that you can use within your console commands for setting up a project.
To begin using it, you need to create a console command in your Laravel project. As an exmaple, let's create a new `SetupCommand` for our project:
```shell
$ php artisan make:command SetupCommand
```
In the `app/Console/Commands` directory, you should have a new `SetupCommand.php` file.
Now
Now, within this file, you can `use` the `ConfiguresApplication` trait in the class and import the file:
```php
namespace App\Console\Commands;
use DFurnes\Environmentalist\ConfiguresApplication;
use Illuminate\Console\Command;
class SetupCommand extends Command
{
use ConfiguresApplication;
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'setup';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Configure your application.';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return void
*/
public function handle()
{
// Setup code and environmentalist configuration methods used here!
}
}
```
Be sure to set a `$signature` to define the name of the command to run, and a `$description` that describes what it does.
### License
MIT © [David Furnes](https://dfurnes.com)