Skip to content

Commit 8d2301c

Browse files
committed
Added illustration animations to README
1 parent 84e3a47 commit 8d2301c

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

.README_images/jig-generate.gif

359 KB
Loading

.README_images/jig-preview.gif

856 KB
Loading

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
[![Quality Score](https://img.shields.io/scrutinizer/g/coolsam726/jetstream-inertia-generator.svg?style=flat-square)](https://scrutinizer-ci.com/g/coolsam726/jetstream-inertia-generator)
66
[![Total Downloads](https://img.shields.io/packagist/dt/savannabits/jetstream-inertia-generator.svg?style=flat-square)](https://packagist.org/packages/savannabits/jetstream-inertia-generator)
77

8-
**Jetstream Inertia Generator** a.k.a **jig** allows you to generate code for simple Admin CRUDs (Create, Read, UPdate, Delete) which are fully compatible with a Laravel Project powered by the [Jetstream - Inertia - Vue.js](https://jetstream.laravel.com/2.x/stacks/inertia.html) Stack.
8+
**Jetstream Inertia Generator** a.k.a **jig** allows you to generate code for simple Admin CRUDs (Create, Read, UPdate, Delete) which are fully compatible with a Laravel Project powered by the [Jetstream - Inertia - Vue.js](https://jetstream.laravel.com/2.x/stacks/inertia.html) Stack.
9+
![](.README_images/jig-preview.gif)
910
## Scenario
1011
You are developing a NextGen project. The data model is complex. It requires **Many CRUDS** managed by the admin in order to power the main end-user functionality. You don't want to spend **Days or even Months** writing boilerplate code for all the CRUDs.
1112
If that is you, this package comes to your rescue. Just follow these simple steps:
1213

1314
* Generate a Migration for your CRUD table, e.g articles, and run `php artisan migrate` (About **2 minutes**)
1415
* With this package, just run `php artisan jig:generate articles` (About **3 seconds!!!**)
1516
* Build your css and javascript (About **27 seconds**)
16-
1717
DONE! In about **2 and a half minutes**, you get a fully working module consisting of -:
1818
- Model
1919
- Admin Controller - Index, Create, Show, Edit, Store, Update, Delete
@@ -148,12 +148,13 @@ NB: If you had already separately published laravel-permission's migrations, the
148148
```
149149
## Usage
150150
The hard part is over. This is the easy part.
151-
##Prepare:
152-
### General Steps:
151+
### General Steps to generate a CRUD:
152+
![](.README_images/jig-generate.gif)
153+
1. Generate and write a migration for your table with `php artisan make:migration` command.
154+
2. Run the migration to the database with `php artisan migrate` command
155+
3. Generate the Whole Admin Scaffold for the module with `php artisan jig:generate` command
156+
4. Modify and customize the generated code to suit your specific requirements if necessary.
153157

154-
2. Generate and write a migration for your table with `php artisan make:migration` command.
155-
3. Run the migration to the database with `php artisan migrate` command
156-
4. Generate the Whole Admin Scaffold for the module with `php artisan jig:generate` command
157158
### Example
158159
Assuming you want to generate a `books` table:
159160
```shell

0 commit comments

Comments
 (0)