Laravel >=5.1
PHP >= 5.5.9
Open your terminal(CLI), go to the root directory of your Laravel project, then follow the following procedure.
-
Run
composer require appzcoder/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('Appzcoder\CrudGenerator\CrudGeneratorServiceProvider'); } }
-
Install laravelcollective/html helper package if you haven't installed it already.
- Run
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="Appzcoder\CrudGenerator\CrudGeneratorServiceProvider"
Note: You should have configured database for this operation.
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
{
"fields": [
{
"name": "title",
"type": "string"
},
{
"name": "content",
"type": "text"
},
{
"name": "category",
"type": "select",
"options": ["technology", "tips", "health"]
}
]
}
php artisan crud:generate Posts --fields_from_file="/path/to/fields.json" --view-path=admin --controller-namespace=Admin --route-group=admin
Options:
Option | Description |
---|---|
--fields |
Fields name for the form & migration. e.g. --fields="title#string; content#text; category#select#options=technology,tips,health; user_id#integer#unsigned" |
--fields_from_file |
Fields from a JSON file. e.g. --fields_from_file="/path/to/fields.json" |
--route |
Include Crud route to routes.php? yes or no |
--pk |
The name of the primary key |
--view-path |
The name of the view path |
--controller-namespace |
The namespace of the controller - sub directories will be created |
--model-namespace |
The namespace that the model will be placed in - directories will be created |
--route-group |
Prefix of the route group |
--pagination |
The amount of models per page for index pages |
--indexes |
The fields to add an index to. append "#unique" to a field name to add a unique index. Create composite fields by separating fieldnames with a pipe (```--indexes="title,field1 |
--foreign-keys |
Any foreign keys for the table. e.g. --foreign-keys="user_id#id#users#cascade" where user_id is the column name, id is the name of the field on the foreign table, users is the name of the foreign table, and cascade is the operation 'ON DELETE' together with 'ON UPDATE' |
--validations |
Validation rules for the form "col_name#rules_set" e.g. ```"title#min:10 |
--relationships |
The relationships for the model. e.g. --relationships="comments#hasMany#App\Comment" in the format |
--localize |
Allow to localize. e.g. localize=yes |
--locales |
Locales language type. e.g. locals=en |
For controller:
php artisan crud:controller PostsController --crud-name=posts --model-name=Post --view-path="directory" --route-group=admin
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');
These fields are supported for migration and view's form:
- text
- textarea
- password
- number
- date
- datetime
- time
- radio
- select
- file
- string
- char
- varchar
- date
- datetime
- time
- timestamp
- text
- mediumtext
- longtext
- json
- jsonb
- binary
- integer
- bigint
- mediumint
- tinyint
- smallint
- boolean
- decimal
- double
- float
- enum
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="Appzcoder\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.