Download the PHP package luthfi/simple-crud-generator without Composer
On this page you can find all versions of the php package luthfi/simple-crud-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download luthfi/simple-crud-generator
More information about luthfi/simple-crud-generator
Files in luthfi/simple-crud-generator
Package simple-crud-generator
Short Description A simple CRUD generator for Laravel 5.5 (and later) with Bootstrap 4.
License MIT
Informations about the package simple-crud-generator
Laravel Simple CRUD Generator
Need faster TDD in Laravel project? This is a simple CRUD generator complete with automated testing suite.
Documentation
For installation instructions and usage, please take a look at the official documentation.
About this package
This package contains artisan make:crud
commands to create a simple CRUD feature with test classes on our Laravel 5.5 (and later) application. This package is fairly simple, to boost test-driven development method on our laravel application.
With this package installed on local environment, we can use (e.g.) php artisan make:crud Vehicle
command to generate some files :
App\Models\Vehicle.php
eloquent modelxxx_create_vehicles_table.php
migration fileVehicleController.php
index.blade.php
andforms.blade.php
view file inresources/views/vehicles
directoryresources/lang/vehicle.php
lang fileVehicleFactory.php
model factory fileVehiclePolicy.php
model policy file inapp/Policies
directoryManageVehiclesTest.php
feature test class intests/Feature
directoryVehicleTest.php
unit test class intests/Unit/Models
directoryVehiclePolicyTest.php
unit test class intests/Unit/Policies
directory
It will update some file :
- Update
routes/web.php
to addvehicles
resource route - Update
app/providers/AuthServiceProvider.php
to add Vehicle model Policy class in$policies
property
It will also create this file if it not exists :
resources/lang/app.php
lang file if it not existstests/BrowserKitTest.php
base Feature TestCase class if it not exists
Main purpose
The main purpose of this package is for faster Test-driven Development, it generates model CRUD scaffolds complete with Testing Classes which will use Laravel Browserkit Testing package and PHPUnit.
How to install
For Laravel 10x
For Laravel 9.x
For Laravel 8.x
For Laravel 5.6 to 7.x
For Laravel 5.5
To use this package on laravel 5.5, we need to add the package (with browserkit) within require-dev
in composer.json
file, like so :
The package will auto-discovered.
How to use
Just type in terminal $ php artisan make:crud ModelName
command, it will create simple Laravel CRUD files of given model name completed with tests.
For example we want to create CRUD for 'App\Models\Vehicle' model.
Make sure we have set database credential on .env
file, then :
Then visit our application url: http://localhost:8000/vehicles
.
Usage on Fresh Install Laravel 8.x
In this example, we are using the laravel installer package to install new laravel project.
Available Commands
Model Attribute/column
The Model and table will only have 2 pre-definded attributes or columns : title and description on each generated model and database table. You can continue working on other column on the table.
Bootstrap 4 Views
The generated view files use Bootstrap 4 by default (for Laravel 5.6 and later).
Bootstrap 3 Views
We can also generates views that use Bootstrap 3 with --bs3
command option, eg for Laravel version 5.5.
For API
If we want to generate API Controller with feature tests, we use following command :
By default, we use Laravel Token Based Authentication, so we need to update our user model.
- Add
api_token
column on our users_table_migration. - Add
api_token
as fillable property on User model. - Add
api_token
field on our UserFactory.
API Usage
The generated API is a REST API, using GET and POST verbs, with a URI of /api/modelname
.
Example code for calling the generated API, using Guzzle:
// Read data a specific Vehicle record...
$uri = 'http://your-domain.com/api/vehicles/'.$vehicleID;
$headers = ['Authorization' => 'Bearer '.$apiToken];
$client = new \GuzzleHttp\Client();
$res = $client->request('GET', $uri, ['headers' => $headers]);
// Create a new Vehicle record...
$uri = 'http://your-domain.com/api/vehicles';
$headers = ['Authorization' => 'Bearer '.$apiToken];
$payload = json_encode([
'title' => 'Vehicle Name 1',
'description' => 'Vehicle Description 1',
]);
$client = new \GuzzleHttp\Client();
$res = $client->request('POST', $uri, ['body' => $payload, 'headers' => $headers]);
The generated functional tests will give you examples of how to adapt this code for other call types.
Config file
You can configure your own by publishing the config file:
That will generate config/simple-crud.php
file.
By default, this package have some configuration:
Publishing Stub Files
Stub files is the templates which we use to generate the code for each model classes and files. We can customize the stub files as we needed by publishing them to our project directory.
That will generate stub files on stubs/simple-crud
directory. Now we can change some stub files based on our project needs.
Attention
- The package will creates the Model class file, the command will stop if the Model already exists.
- You need a
resources/views/layouts/app.blade.php
view file, simply create one withphp artisan make:auth
command. You can change this configuration via theconfig/simple-crud.php
file.
Screenshots
Visit your application in new resource route : http://127.0.0.1:8000/vehicles
Generated testing suite
Next, let us try the generated testing suite. To use the generated testing classes, we can set the database environment using in-memory database SQLite. Open phpunit.xml
. Add two lines below on the env
:
Then run PHPUnit
All tests should be passed.
Issue/Proposal
If you find any issue, or want to propose some idea to help this package better, please create an issue in this github repo.
License
This package is open-sourced software licensed under the MIT license.