Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheenazien8/hascrudactions
CRUD tirelessly 💤
https://github.com/sheenazien8/hascrudactions
Last synced: about 1 month ago
JSON representation
CRUD tirelessly 💤
- Host: GitHub
- URL: https://github.com/sheenazien8/hascrudactions
- Owner: sheenazien8
- License: mit
- Created: 2020-11-14T17:41:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-02T01:56:06.000Z (over 3 years ago)
- Last Synced: 2024-11-14T18:23:38.739Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 113 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hascrudaction
[](https://packagist.org/packages/sheenazien8/hascrudactions)
[](https://travis-ci.org/sheenazien8/hascrudactions)
[](https://packagist.org/packages/sheenazien8/hascrudactions)
This package allows you to build a CRUD with tiny Controller and keep the pattern are consitent.
## Lifecycles
| Method | Path | Function | Repository Function | Route Name |
| :----------- | :---------- | :----------- | :-------- | :----------- |
| GET | base_domain/path/ | ControllerClass@index | RepositoryClass@datatable | path.index |
| GET | base_domain/path/create | ControllerClass@create | ----- | path.create |
| GET | base_domain/path/{id} | ControllerClass@show | ----- | path.show |
| POST | base_domain/path/ | ControllerClass@store | RepositoryClass@create | path.store |
| GET | base_domain/path/{id} | ControllerClass@edit | ----- | path.edit |
| PUT | base_domain/path/{id} | ControllerClass@update | RepositoryClass@update | path.update |
| DELETE | base_domain/path/{id} | ControllerClass@destroy | RepositoryClass@delete | path.destroy |
| DELETE | base_domain/bulkDestroy/ | ControllerClass@bulkDestroy | RepositoryClass@bulkDestroy | path.bulkDestroy |
## Requirements
* laravel 8.^ **On Development**
* laravel 7.^
* This package uses ```yajra/laravel-datatables``` (https://yajrabox.com/docs/laravel-datatables/master/quick-starter) for index table view under the hood, Please make sure you include this dependencies before using this library.
## Installation
You can install the package via composer:
```bash
composer require sheenazien8/hascrudactions
```
## Configuration
#### Laravel Configuration
```bash
php artisan vendor:publish --provider="Sheenazien8\Hascrudactions\HascrudactionsServiceProvider"
```
#### Register the provider class in config/app.php
```php
"providers" => [
Sheenazien8\Hascrudactions\HascrudactionsServiceProvider::class,
]
```
#### Lumen Configuration
```bash
mkdir -p config
cp vendor/sheenazien8/hascrudactions/config/config.php config/config.php
```
## Basic Usage
First, Generate the Hascrud route with ```php artisan hascrudaction:make Employee``` this command will be generate a few class and file views, Example.
* App\Http\Controllers\EmployeeController
* App\Http\Requests\Employee\\.*
* App\Repositories\EmployeeRepository
* resources/views/employee/\.*
And Setup the datatable.
### Install Datatable Package and Setup
#### Install Composer
```composer require yajra/laravel-datatables```
#### Install Assets
```yarn add datatables.net-bs4 datatables.net-buttons-bs4```
#### Register datatables.net in resources js and css file
```
// Js file
require('bootstrap');
require('datatables.net-bs4');
require('datatables.net-buttons-bs4');
// Scss file
@import "~datatables.net-bs4/css/dataTables.bootstrap4.css";
@import "~datatables.net-buttons-bs4/css/buttons.bootstrap4.css";
```
#### Compile Assets
```yarn dev / watch / prod```
Next, you can add the path in ```routes/web.php```, edit file config in ```config/hascrudactions.php``` for wrapper blade layouts and javascript views, add Traits ```HasLaTable``` in Model Class Employee.
#### routes/web.php
```php
Route::hascrud('employee');
```
#### config/hascrudactions.php
```php
/**
* Wrapper view, you can adjust static view like footer and header
* put file in views path
* layouts:
* section:
* javascript:
*/
'wrapper' => [
'layouts' => 'layouts.app',
'section' => 'content',
'javascript' => 'javascript'
]
```
#### app/Employee.php
```php
use Sheenazien8\Hascrudactions\Traits\HasLaTable;
class Employee extends Model
{
use HasLaTable;
//
}
```
And the last, you can define what columns you want to display in the index view in ```resources/views/employee/components/table.blade.php```, and then you must define what columns you want to add or edit in the model ``Employee`` with ```$fillable``` property and form view ```resources/views/employee/components/form.blade.php```, and also you can get the binding data from controller with the ```$data``` variable name.
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Credits
- [Sheena Zien](https://github.com/sheenazien8)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.