tobidsn / admin-generator
Laravel Admin CRUD Generator
Requires
- php: ^7.1 || ^8.0
- illuminate/support: ^6.0|^7.0|^8.0
Requires (Dev)
- mockery/mockery: ~1.3.3|^1.4.2
- phpunit/phpunit: ^8.5.8|^9.3.3
README
This Generator package provides various generators like Admin CRUD, Controller, Model, View based from table for your painless development of your applications.
Requirements
Laravel >= 5.5
PHP >= 7.0
Installation
composer require tobidsn/admin-generator
Once the package is installed, you should register the Tobidsn\CrudGenerator\CrudGeneratorServiceProvider
service provider. Normally, Laravel 5.5+ will register the service provider automatically.
After that, publish its assets using the vendor:publish
Artisan command:
php artisan vendor:publish --provider="Tobidsn\CrudGenerator\CrudGeneratorServiceProvider"
Usage
Generating Migrations
php artisan make:migration create_users_table
Running Migrations
php artisan migrate
Admin CRUD Command
php artisan crud:admin User --table=users
Signature information
protected $signature = 'crud:admin {name : Class (singular) for example User} {--table= : The name of the Table.} {--model= : The name of the Model.} {--route-group= : The name of the Model.} {--view-path= : The name of the view path.}';
Test
php artisan serve
Please Login to laravel and access http://localhost:8000/admin/user
Configuration
You will find a configuration file located at config/crudgenerator.php
Custom Template
When you want to use your own custom template files, then you should turn it on and it will use the files from resources/stubs/
'custom_template' => true,
Path
You can change your template path easily, the default path is resources/stubs/
.
'path' => base_path('resources/stubs/'),
View Columns
When generating CRUD or the views, the generator will assume the column number to show for the CRUD grid or detail automatically from the config. You can change it.
'view_columns_number' => 5,
Custom Delimiter
Set your delimiter which you use for your template vars. The default delimiter is %%
in everywhere.
'custom_delimiter' => ['%%', '%%'],
Note: You should use the delimiter same as yours template files.
View Template Vars
This configuration will help you to use any custom template vars in the views index
, form
,list
, create
, edit
, show
'dynamic_view_template' => [],
Route group
Route group of the controller
'route_group' => 'admin',
View path
View path for view generator
'view_path' => '_admin',
Form Helper
Helper for custom view and form
'form_helper' => 'adminlte3',
Custom Templates
The package allows user to extensively customize or use own templates.
All Templates
To customize or change the template, you need to follow these steps:
-
Just make sure you've published all assets of this package. If you didn't just run this command.
php artisan vendor:publish --provider="Tobidsn\CrudGenerator\CrudGeneratorServiceProvider"
-
To override the default template with yours, turn on
custom_template
option in theconfig/crudgenerator.php
file.'custom_template' => true,
-
Now you can customize everything from this
resources/stubs/
directory. -
Even if you need to use any custom variable just add those in the
config/crudgenerator.php
file.
License
This project is licensed under the MIT License - see the License File for details