Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mochgani/crud-laravel
https://github.com/mochgani/crud-laravel
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mochgani/crud-laravel
- Owner: mochgani
- Created: 2023-12-18T07:42:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-01-05T09:50:18.000Z (11 months ago)
- Last Synced: 2024-10-12T11:43:24.450Z (about 1 month ago)
- Language: PHP
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Crud Generator Laravel 9 and 10 (your time saver)
Crud Generator Laravel is a package that you can integrate in your Laravel to create a REAL CRUD. It includes :
- **Controller** with all the code already written
- **Views** (index, create, edit, show)
- **Model** with relationships
- **Request** file with validation rules
- **Migration** file
## Installation
1\. Run the following composer command:
``` composer require mochgani/crud-laravel:dev-main ```
2\. If you don't use Laravel Collective Form package in your project, install it:
``` composer require laravelcollective/html ```
(Note: This step is not required if you don't need views.)
3\. Publish the configuration file, stubs and the default-theme directory for views:
``` php artisan vendor:publish --provider="Mochgani\CrudLaravel\CrudgenServiceProvider" ```
## Usage
### Create CRUD (or REST API)
Let's illustrate with a real life example : Building a blog
A `Post` has many (hasMany) `Comment` and belongs to many (belongsToMany) `Tag`
A `Post` can have a `title` and a `content` fields
Let's do this 🙂
If you need a REST API instead of CRUD, [read this wiki](https://github.com/misterdebug/crud-generator-laravel/wiki/Make-a-complete-REST-API-instead-of-CRUD)
#### CRUD generator command :
``` php artisan make:crud nameOfYourCrud "column1:type, column2" ``` (theory)
``` php artisan make:crud post "title:string, content:text" ``` (for our example)
[Available options](https://github.com/misterdebug/crud-generator-laravel/wiki/Available-options-when-you-use-make:crud-command)
[Generate CRUD with livewire datatable](https://github.com/misterdebug/crud-generator-laravel/wiki/Generate-CRUD-with-livewire-datatable)
When you call this command, the controller, views and request are generated with your fields (in this case, title and content).
Now let's add our relationships (`Comment` and `Tag` models) :
We add a `hasMany` relationship between our `Post` and `Comment`
and a `belongsToMany` with `Tag`
Two migrations are created (`create_posts` AND `create_post_tag`).
`create_posts` is your table for your `Post` model
`create_post_tag` is a pivot table to handle the `belongsToMany` relationship
`Post` model is generated too with both relationships added
### Migration
Both migration files are created in your **database/migrations** directory. If necessary edit them and run :
``` php artisan migrate ```
## Remove a CRUD
You can delete all files (except migrations) created by the `make:crud` command at any time. No need to remove files manually :
``` php artisan rm:crud nameOfYourCrud --force ```
``` php artisan rm:crud post --force ``` (in our example)
The `--force` flag (optional) deletes all files without confirmation
## License
This package is licensed under the [license MIT](http://opensource.org/licenses/MIT).
## Source
- **[misterdebug/crud-generator-laravel](https://github.com/misterdebug/crud-generator-laravel/)**: Source Library CRUD Generator