Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leogopal/laravel-startercrud

A CRUD Artisan helper for the Laravel Starterkit
https://github.com/leogopal/laravel-startercrud

Last synced: 21 days ago
JSON representation

A CRUD Artisan helper for the Laravel Starterkit

Awesome Lists containing this project

README 

        
# Laravel Starterkit Artisan CRUD



[![Latest Stable Version](https://poser.pugx.org/leogopal/laravel-startercrud/version)](https://packagist.org/packages/leogopal/laravel-startercrud)

[![Total Downloads](https://poser.pugx.org/leogopal/laravel-startercrud/downloads)](https://packagist.org/packages/leogopal/laravel-startercrud)

[![License](https://poser.pugx.org/leogopal/laravel-startercrud/license)](https://packagist.org/packages/leogopal/laravel-startercrud)



This is an Artisan based package for the [Laravel Starterkit](https://github.com/leogopal/laravel-starterkit)



## Install



Via Composer



``` bash

$ composer require leogopal/laravel-startercrud

```



## Usage



Creates a Model, Controller (with Repository, validation Requests, Events and Listeners), Migration, Routes, Breadcrumbs and CRUD Views for the given name ready to work.



It does not overwrite any files that may exist with the pre-stablished names. So, if you delete one of the files and run the command again, the deleted file will be created again and the rest will be ignored and will keep the changes you could have made.



## Run



In your Laravel project root folder:



```

php artisan lg:crud example

```



Where _example_ is the name you want for your model (routes, views, controllers,...). I've tried to follow best naming practices and it uses plural or singular names and lower or uppercase where needed. You can also use camelCase or snake_case.



Parameters _example_, _Example_, _examples_ or _EXAMPLES_ all give the same results.



Then run the created migration:



```

php artisan migrate

```



In your browser open:



```

https://YOUR_SITE/admin/examples

```



**...et voilà! :)**



Note: out of the box, the table comes only with a _title_ text field, besides the _id_, _deleted_at_, _created_at_ and _updated_at_. Edit your newly created migration file to add any other you may need before runnning the migrate command.



## Options



You can create all the files and run the migration by running the command with the --migrate option:



```

php artisan lg:crud example --migrate



or



php artisan lg:crud example -m

```



You may also specify the name of the default text field 'title' to whatever other you prefer with the --field option:



```

php artisan lg:crud example --field=name



or



php artisan lg:crud example -f name

```



## Include a menu item



A file named _sidebar-examples.blade.php_ is created in the folder _/resources/views/backend/example/includes_. It contains the html code for a menu item to access your recently created views. You can show it in your sidebar by including the following line in _/resources/views/backend/includes/sidebar.blade.php_ wherever you want it to appear:



```

@include('backend.example.includes.sidebar-examples')

```



## Events and Listeners



The package generates three events and listeners for creating, updating and deleting items methods. In order to get these to work you must resgister them with the event dispatcher, adding this line to your _Providers/EventServiceProvider.php_ file (under _Backend Subscribers_):



```

\App\Listeners\Backend\Example\ExampleEventListener::class

```



## Language lines



Following are the _labels.php_, _menus.php_ and _validation.php_ English language lines needed, copy them into the files in _/resources/lang/en_ or whatever other language folder you may need. Replace _Example_ for the name of your Model.



TODO: generate a file with all the customized language lines ready to copy&paste.



**labels.php** under _'backend'_:



```

'examples' => [

    'management'    => 'Example Management',

    'active'        => 'Active Examples',

    'view'          => 'View Example',

    'edit'          => 'Edit Example',

    'create'        => 'Create Example',

    'create_new'    => 'Create New Example',

    'table'         => [

        'title'         => 'Title',

        'created'       => 'Created',

        'last_updated'  => 'Last Updated',

        'deleted'       => 'Deleted',

        'actions'       => 'Actions',

        'tab_title'     => 'Overview',

        'total'         => 'example total|examples total',

    ],



    'tabs' => [

        'title' => 'Overview',

        'content' => [

            'overview'  => [

                'title'         => 'Title',

                'created_at'    => 'Created',

                'last_updated'  => 'Last Updated',

            ],

        ],

    ],



],



_Warning: If you have used the --field option, you should change tabs->content->overview->title to match the field name you have chosen._

```



**menus.php** under _'backend'_



```

'examples' => [

    'main'            => 'Examples',

    'all'             => 'All Examples',

    'create'          => 'Create Example',

    'deleted'         => 'Deleted Examples',

    'view'            => 'View Example',

    'edit'            => 'Edit Example',

],

```



**menus.php** under _'backend' => 'sidebar'_



```

'examples'  => 'Examples',

```



**validation.php** under _'attributes' => 'backend'_



```

'examples' => [

    'title'            => 'Title',

],



_Warning: If you have used the --field option, you should change 'title' to match the field name you have chosen.

```



**alerts.php** under _'backend'_



```

'examples' => [

    'created'                   => 'The example was successfully created.',

    'updated'                   => 'The example was successfully updated.',

    'deleted'                   => 'The example was successfully deleted.',

    'restored'                  => 'The example was successfully restored.',

    'deleted_permanently'       => 'The example was deleted permanently.',

],

```



**buttons.php** under _'backend'_



```

'examples' => [

    'restore' => 'Restore Example',

    'delete_permanently'    => 'Permanently delete Example',

],

```



**exceptions.php** under _'backend'_



```

'examples' => [

    'cant_restore'          => 'This Example is not deleted so it can not be restored.',

    'delete_first'          => 'This Example must be deleted first before it can be destroyed permanently.',

]

```



## Files created



### Model



```

app/Models/Example.php

```



### Trait Attribute



```

app/Models/Traits/Attribute/ExampleAttribute.php

```



This is where the action buttons for the new object are.



### Controller



```

app/Http/Controllers/Backend/ExampleController.php

```



It contains the CRUD methods: _index_, _create_, _store_, _show_, _edit_, _update_, _destroy_, _delete_, _restore_ and _deleted_.



### Repository



```

app/Repositories/Backend/ExampleRepository.php

```



Contains database logic.



### Requests



```

app/Http/Requests/Backend/ManageExampleRequest.php

app/Http/Requests/Backend/StoreExampleRequest.php

app/Http/Requests/Backend/UpdateExampleRequest.php

```



Validation manage, store and update Requests.



### Events



```

app/Events/Backend/Example/ExampleCreated.php

app/Events/Backend/Example/ExampleUpdated.php

app/Events/Backend/Example/ExampleDeleted.php

```



### Listeners



```

app/Listeners/Backend/Example/ExampleEventListener.php

```



### Migrations



```

database/migrations/\YYYY_MM_DD_create_examples_table.php

```



### Routes



```

routes/backend/examples.php

```



Contains the named routes _admin.examples.index_, _admin.examples.deleted_, _admin.examples.restore_, _delete-permanently_, _admin.examples.create_, _admin.examples.store_, _admin.examples.show_, _admin.examples.edit_, _admin.examples.update_ and _admin.examples.destroy_.



### Breadcrumbs



```

routes/breadcrumbs/backend/example.php

```



This has the breadcrumbs for the routes

_admin.examples.index_, _admin.examples.create_, _admin.examples.show_, _admin.examples.edit_ and _admin.examples.deleted_.



The following line is added to _routes/breadcrumbs/backend/backend.php_:



```

require **DIR**.'/example.php';

```



If you delete the _routes/breadcrumbs/backend/example.php_ file created by this command, don't forget to delete this line or your whole project will crash.



### Views



```

resources/views/backend/example/index.blade.php

resources/views/backend/example/show.blade.php

resources/views/backend/example/create.blade.php

resources/views/backend/example/edit.blade.php

resources/views/backend/example/deleted.blade.php

resources/views/backend/example/includes/breadcrumb-links.blade.php

resources/views/backend/example/includes/header-buttons.blade.php

```



If you add more fields to your datatable, you'll have to edit _show.blade.php_, _create.blade.php_ and _edit.blade.php_ to suit your needs.



### Menu item



```

sidebar-examples.blade.php

```



HTML code for the menu item for your Laravel 5 starterkit sidebar.



## License



The MIT License (MIT). Please see [License File](LICENSE.md) for more information.