Laravel CRUD Generator Web&Api

Need faster TDD in Laravel project? This is a simple CRUD generator complete with automated testing suite.

About this package

This is sample Package for Start Up Project if you need something professional use ZoolFlat - or - laravel-generator .

This package contains artisan make:crud commands to create a simple CRUD feature with test classes on our Laravel 5.8 (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 Booking command to generate some files :

App\Booking.php eloquent model
xxx_create_bookings_table.php migration file
BookingController.php
index.blade.php and forms.blade.php view file in resources/views/bookings directory
resources/lang/booking.php lang file
BookingFactory.php model factory file
BookingPolicy.php model policy file in app/Policies directory
ManageBookingTest.php feature test class in tests/Feature directory
BookingTest.php unit test class in tests/Unit/Models directory
BookingPolicyTest.php unit test class in tests/Unit/Policies directory

It will update some file :

Update routes/web.php to add bookings 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 exists
tests/BrowserKitTest.php base Feature TestCase class if it not exists

Main purposef

The main purpose of this package is for TDD. 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

Only work on Laravel 5.8 or later

# Get the package
$ composer require tayeb-ali/zool-crud --dev

The package will auto-discovered and ready to go.

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\Booking' model.

php artisan make:auth
$ php artisan make:crud-simple Booking 
or add to model file
$ php artisan make:crud-simple {fileName}/Booking

Booking resource route generated on routes/web.php.
Booking model generated.
Booking table migration generated.
BookingController generated.
Booking index view file generated.
Booking form view file generated.
lang/app.php generated.
Booking lang files generated.
Booking model factory generated.
Booking model policy generated.
AuthServiceProvider class has been updated.
BrowserKitTest generated.
ManageVehiclesTest generated.
BookingTest (model) generated.
BookingPolicyTest (model policy) generated.
ZoolCRUD files generated successfully!

Make sure we have set database credential on .env file, then :

$ php artisan migrate
$ php artisan serve

Then visit our application url: http://localhost:8000/bookings.

Usage on Fresh Install Laravel

If you are using this package from from the fresh laravel project.

# This is example commands for Ubuntu users.
$ composer create-project laravel/laravel --prefer-dist project-directory
$ cd project-directory
$ vim .env # Edit your .env file to update database configuration

# Install the package
$ composer require tayeb-ali/zool-crud --dev

# Create auth scaffolds to get layout.app view, register and login feature
$ php artisan make:auth

$ php artisan make:crud Booking # Model name in singular
# I really suggest "git commit" your project right before run make:crud command

$ php artisan migrate
$ php artisan serve
# Visit your route http://127.0.0.1:8000
# Register as new user
# Visit your route http://127.0.0.1:8000/bookings

Available Commands

# Create Full CRUD feature with tests
$ php artisan make:crud ModelName

# Create Full CRUD feature with tests and Bootstrap 3 views
$ php artisan make:crud ModelName --bs3

# Create Simple CRUD feature with tests
$ php artisan make:crud-simple ModelName

# Create Simple CRUD feature with tests and Bootstrap 3 views
$ php artisan make:crud-simple ModelName --bs3

# Create API CRUD feature with tests
$ php artisan make:crud-api ModelName

Model Attribute/column

The Model and table will only have 2 pre-definded attributes or columns : name 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 :

$ php artisan make:crud-api Vehicle

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([
    'name' => '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:

$ php artisan vendor:publish --provider="Tayeb\ZoolCrud\ServiceProvider"

That will generate config/simple-crud.php file.

By default, this package have some configuration:

<?php

return [
    // The master view layout that generated views will extends
    'default_layout_view' => 'layouts.app',

    // The base test case class path for generated testing classes
    'base_test_path' => 'tests/BrowserKitTest.php',

    // The base test class full name
    'base_test_class' => 'Tests\BrowserKitTest',
];

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 with php artisan make:auth command. You can change this configuration via the config/simple-crud.php file.

Screenshots

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.

madfortech / ZoolCrud