ab-creative/laravel-maker

Laravel 5.6 scaffolding generator

Laravel Maker

Overview

Laravel Maker is a tool to kick start project development and help with prototyping by creating scaffolding from YAML based definitions., _(*1)

Premise

There are some amazing and highly complex CRUD and Admin resource_types but the aim of this is to create an opinionated scaffolding builder without many options but that is easy to hack and modify., _(*2)

The package is designed to read from a yaml file (or files) that define the migrations, class names, labels etc., _(*3)

The package is also capable of reading from an existing database table to so that crud can be created for that., _(*4)

Requirements

Laravel 5.5+, _(*5)

Overview

This package reads a yaml file and then creates the following resources:, _(*6)

• Public facing controller
• Admin controller
• Update request
• Store request
• Model
• Model Repository
• Migration
• Model factory
• Routes
• Public view templates
• Admin view templates

Yaml

The yaml files are defined in /database/models, _(*7)

Commands

Contains the Artisan commands, _(*8)

stubs

This directory mirrors the structure of Laravel and is setup to use Request and Repository classes., _(*9)

These files will processed and placeholders replaced in order to generate the scaffolding files., _(*10)

Stubs can be overloaded on a individual basis based on a path defined in config, _(*11)

Templates

This also mirrors the structure of Laravel., _(*12)

e.g. BaseController, BaseModel, _(*13)

These files will be published as is., _(*14)

Placeholders

__MODEL.NAME__ The name of the model class e.g. Post, _(*15)

__VIEW.RESOURCE.DIRECTORY__ e.g. posts, _(*16)

__VIEW.NAMESPACE.DIRECTORY__ e.g. admin, _(*17)

__ROUTE.PATH__ The Admin route in dot format e.g. posts, _(*18)

__ROUTE.AS__ The route prefix defined as 'as' in the route group variable e.g. admin, _(*19)

__MODEL.NAME.HUMAN__ The singular friendly name of the model e.g. post, _(*20)

__MODEL.NAME.HUMAN.PLURAL__ The plural friendly name of the model e.g. posts, _(*21)

__MODEL.VAR.NAME__ The singular variable name of the model e.g. post, _(*22)

__MODEL.VAR.NAME.PLURAL__ The plural variable name of the model e.g. posts, _(*23)

Getting started

1. Setup a Laravel site as normal..., _(*24)

2. laravel new t6.example.com, _(*25)

3. php artisan key:generate, _(*26)

4. Edit .env, _(*27)

5. php artisan migrate, _(*28)

6. php artisan make:auth, _(*29)

7. Create and cd into /packages/AbCreative directory, _(*30)

8. git clone https://github.com/ab-creative/laravel-maker.git, _(*31)

9. Edit /composer.json to add the package:, _(*32)

"autoload": {
        "classmap": [
            "database/seeds",
            "database/factories"
        ],
        "psr-4": {
            "App\\": "app/",
            "AbCreative\\LaravelMaker\\": "packages/AbCreative/laravel-maker/src"
        }
    },

1. Add the package to config/app.php providers:

/*
 * Package Service Providers...
 */

AbCreative\LaravelMaker\LaravelMakerServiceProvider::class,

1. Copy the test example.yaml definition from stubs/database/definitions/ into the main laravel /database/definitions/, _(*33)

2. Install the composer dependencies from the package in root e.g., _(*34)

composer require symfony/yaml --dev, _(*35)

composer require laracasts/generators --dev, _(*36)

composer require laravelcollective/html, _(*37)

1. Create an admin user if necessary [http://blog.indiefolk.co.uk/laravel-4-create-users-with-artisan-tinker/]

Tests

cd into /packages/abcreative/laravel-maker/ directory, _(*38)

run `../../../vendor/bin/phpuni, _(*39)

How to use

Use the generator via artisan e.g. php artisan build:command, _(*40)

file is a yaml file defined in /database/definitions/, _(*41)

tables a comma separated list of tables, _(*42)

--clean will delete an existing file, _(*43)

--force will overwrite an existing file, _(*44)

build:clean file Delete all the files generated by the package, _(*45)

build:controller file --force --clean Create a new controller, _(*46)

build:crud file --force --clean Create a new model, controllers, routes, views and migration, _(*47)

build:migration file --force --clean Create a new set of migrations, _(*48)

build:model file --force --clean Create a new model, _(*49)

build:request file --force --clean Create a new set of request classes, _(*50)

build:route file --force --clean Create a new route, _(*51)

build:view file --force --clean Create a new set of view files, _(*52)

build:yaml tables --force --clean Create Yaml from one or more database tables, _(*53)

Copyright

This package has been developed by AB Multimedia Ltd, _(*54)

Copyright (c) 2018 AB Multimedia Ltd, _(*55)

For the full copyright and license information, please view the LICENSE file that was distributed with this source code., _(*56)

License

This package is open-sourced software licensed under the MIT license., _(*57)