README

Requirements

Laravel >=5.1
PHP >= 5.5.9

Installation

Open your terminal(CLI), go to the root directory of your Laravel project, then follow the following procedure.

Run

composer require codeg8/crud-generator --dev

Since the package is only use in local developmnet, add the provider in app/Providers/AppServiceProvider.php.

public function register()
{
    if ($this->app->environment() == 'local') {
        $this->app->register('Codeg8\CrudGenerator\CrudGeneratorServiceProvider');
    }
}

Install laravelcollective/html helper package if you haven't installed it already.

composer require laravelcollective/html

Add service provider & aliases to config/app.php.

'providers' => [
    ...

    Collective\Html\HtmlServiceProvider::class,
],

'aliases' => [
    ...

    'Form' => Collective\Html\FormFacade::class,
    'HTML' => Collective\Html\HtmlFacade::class,
],

Run composer dump-autoload

Publish vendor files of this package.

php artisan vendor:publish --provider="Codeg8\CrudGenerator\CrudGeneratorServiceProvider"

Note: You should have configured database for this operation.

Commands

Crud command:

php artisan crud:generate Posts --fields="title#string; content#text; category#select#options=technology,tips,health" --view-path=admin --controller-namespace=Admin --route-group=admin

Crud fields from a JSON file:

{
    "fields": [
        {
            "name": "title",
            "type": "string"
        },
        {
            "name": "content",
            "type": "text"
        },
        {
            "name": "category",
            "type": "select",
            "options": ["technology", "tips", "health"]
        },
        {
            "name": "user_id",
            "type": "integer#unsigned"
        }
    ],
    "foreign_keys": [
        {
            "column": "user_id",
            "references": "id",
            "on": "users",
            "onDelete": "cascade"
        }
    ],
    "relationships": [
        {
            "name": "user",
            "type": "belongsTo",
            "class": "App\\User"
        }
    ],
    "validations": [
        {
            "field": "title",
            "rules": "required|max:10"
        }
    ]
}

php artisan crud:generate Posts --fields_from_file="/path/to/fields.json" --view-path=admin --controller-namespace=Admin --route-group=admin

Options:

Other commands (optional):

For controller:

php artisan crud:controller PostsController --crud-name=posts --model-name=Post --view-path="directory" --route-group=admin

Controller's Options:

For model:

php artisan crud:model Post --fillable="['title', 'body']"

For migration:

php artisan crud:migration posts --schema="title#string; body#text"

For view:

php artisan crud:view posts --fields="title#string; body#text" --view-path="directory" --route-group=admin

By default, the generator will attempt to append the crud route to your Route file. If you don't want the route added, you can use this option --route=no.

After creating all resources, run migrate command. If necessary, include the route for your crud as well.

php artisan migrate

If you chose not to add the crud route in automatically (see above), you will need to include the route manually.

Route::resource('posts', 'PostsController');

Supported Field Types

These fields are supported for migration and view's form:

Form Field Types:

text
textarea
password
email
number
date
datetime
time
radio
select
file

Migration Field Types:

string
char
varchar
date
datetime
time
timestamp
text
mediumtext
longtext
json
jsonb
binary
integer
bigint
mediumint
tinyint
smallint
boolean
decimal
double
float
enum

Custom Generator's Stub Template

You can customize the generator's stub files/templates to achieve your need.

Make sure you've published package's assets.

php artisan vendor:publish --provider="Codeg8\CrudGenerator\CrudGeneratorServiceProvider"

Turn on custom_template support on config/crudgenerator.php
```
'custom_template' => true,
```
From the directory resources/crud-generator/ you can modify or customize the stub files.
On config/crudgenerator.php you can add new stubs and choose which values are passed

codeg8 / crud-generator

Maintainers

Details