rohinigeeks/laravel-sorcery

Laravel API/Scaffold/CRUD Generator from just one command with including Controller, Repository, Model, Migrations, routes.php update.

Laravel API/Scaffold/CRUD Generator (Laravel5)

, _(*1)

Laravel Sorcery generates boilerplate code for a Laravel Web App from the MySQL Schema, _(*2)

This command Generator generates following things: * Migration File * Model * Repository (optional) * Controller * View * index.blade.php * show.blade.php * create.blade.php * edit.blade.php * fields.blade.php * updates routes.php, _(*3)

Here is the full documentation., _(*4)

Steps to Get Started

1. Add this package to your composer.json:, _(*5)

   "require": {
       "rohinigeeks/laravel-sorcery": "dev-master"
   }

2. Run composer update, _(*6)

   composer update

3. Add the ServiceProviders to the providers array in config/app.php.
   As we are using these two packages illuminate/html & laracasts/flash as a dependency.
   so we need to add those ServiceProviders as well., _(*7)

   'Illuminate\View\ViewServiceProvider',
   'Illuminate\Html\HtmlServiceProvider',
   'Laracasts\Flash\FlashServiceProvider'
   'Rohinigeeks\Generator\GeneratorServiceProvider'

Also for convenience, add these facades in alias array in config/app.php., _(*8)

    'Form'  => 'Illuminate\Html\FormFacade',
    'HTML'  => 'Illuminate\Html\HtmlFacade',
    'Flash' => 'Laracasts\Flash\Flash'

1. Publish generator.php, _(*9)

   php artisan vendor:publish --provider='Rohinigeeks\Generator\GeneratorServiceProvider'

2. Fire the artisan command to generate API for Model, or to generate scaffold with views for web applications, _(*10)

   php artisan rohinigeeks.generator:api ModelName
   php artisan rohinigeeks.generator:scaffold ModelName

   e.g., _(*11)

   php artisan rohinigeeks.generator:api Project
   php artisan rohinigeeks.generator:api Post
   
   php artisan rohinigeeks.generator:scaffold Project
   php artisan rohinigeeks.generator:scaffold Post

3. And You are ready to go. :), _(*12)

Documentation

Generator Config file

Config file (config/generator.php) contains path for all generated files, _(*13)

path_migration - Path where Migration file to ge generated
path_model - Path where Model file to ge generated
path_repository - Path where Repository file to ge generated
path_controller - Path where Controller file to ge generated
path_views - Path where views will be created
path_request - Path where request file will be created
path_routes - Path of routes.php (if you are using any custom routes file)
, _(*14)

namespace_model - Namespace of Model
namespace_repository - Namespace of Repository
namespace_controller - Namespace of Controller
namespace_request - Namespace for Request
, _(*15)

Field Input

Here is the input for the fields by which you can specify Input., _(*16)

    fieldName:fieldType,options:fieldOptions

e.g.,, _(*17)

    email:string:unique
    email:string:unique,default('me@mitul.me')
    title:string,100
    price:flat,8,4

Parameters will be in the same sequence as Blueprint class function for all types. Option will be printed as it is given in input except unique & primary., _(*18)

API Response Structure

Remember: This response structure is based on the most of my API response structure, you can change it to your API response after file generation in controller., _(*19)

Success, _(*20)

    {
        "flag":true,
        "message":"success message",
        "data":{}
    }

data can be anything as per response., _(*21)

Failure, _(*22)

    {
        "flag":false,
        "message":"failure message",
        "code": 0
        "data":{}
    }

data will be optional. And code will be error code., _(*23)

Generated Views

While generating scaffold, all views are created with basic CRUD functionality. (currently delete is not working), _(*24)

Views will be created in resources/views/modelName folder,, _(*25)

    index.blade.php - Main Index file for listing records
    create.blade.php - To insert a new record
    edit.blade.php - To edit a record
    fields.blade.php - Common file of all model fields, which will be used create and edit record
    show.blade.php - To display a record

Credits

This API Generator was forked from laravel-api-generator created by 1. Jamison Valenta 2. Mitul Golakiya. 3. [Bernhard Breytenbach] (https://github.com/Xethron), _(*26)

Screenshots

Command Execution

, _(*27)

Generated Files & routes.php

, _(*28)

Migration File

, _(*29)

Model File

, _(*30)

Repository File

, _(*31)

Controller File

, _(*32)

View Files

, _(*33)