https://github.com/davidpeach/laravel-base-command

A little base package to help create an automated setup flow in a fresh Laravel project.
https://github.com/davidpeach/laravel-base-command

laravel

Last synced: 16 days ago
JSON representation

A little base package to help create an automated setup flow in a fresh Laravel project.

• Host: GitHub
• URL: https://github.com/davidpeach/laravel-base-command
• Owner: davidpeach
• License: mit
• Created: 2020-10-28T14:36:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-11-24T15:37:20.000Z (about 3 years ago)
• Last Synced: 2024-11-01T17:42:23.684Z (2 months ago)
• Topics: laravel
• Language: PHP
• Homepage:
• Size: 70.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel Base Command

A little package to help create an automated flow in a Laravel project.

Let's say you or your company build Laravel sites / apps regularly. And let's say that there are a bunch of steps 

you go through each and every time you start a new project.

Wouldn't it be nice if you could automate that whole process?

Well that is exactly what Laravel Base Command tries to help you with.

By extending this package with your own, and with minimal setup, you can get a working setup flow.

## Quick Start

### Installation

```bash

composer require davidpeach/laravel-base-command

```

### Usage

#### Required files in your child package

As Laravel Base Command attempts to do most of the heavy lifting for you, you only really need to create your `Step` 

classes -- one for each step that you wish to perform.

 - A `ServiceProvider` class that extends `BaseCommandServiceProvider`

 - A set of `Step` classes in your package's `/src/Steps` folder. A step class must extend either `StepAlways`, 

   `StepBinary` or `StepChoice`.

#### Process

1. Extend the base command service provider with your own.

2. Add your command class that extends BaseCommand and add it to your service provider.

3. Create your command classes.

4. Add a list of your command classes in your command class that extends BaseCommand.

5. Run your setup command.

When extending `laravel-base-command`, you define a command to run in order to run through your setup process. "Your 

setup command" is just the command that you run. e.g. `php artisan mycompany:setup`.

Essentially, your own package's Service Provider should extend the one in this project. Then you just create as many Task classes as is needed for your own setup steps.

Your own steps should extend either `StepAlways`, `StepBinary` or `StepChoices`.

A full explanation and documentation is coming soon.

Thanks for your patience,

Dave.