Browse Source

Update readme for crud-api command usage

tags/1.1.0^0 1.1.0
Nafies Luthfi 8 years ago
parent
commit
5e451a831b
  1. 29
      readme.md

29
readme.md

@ -62,9 +62,22 @@ Luthfi\CrudGenerator\ServiceProvider::class,
## How to use
Just type in terminal `$ php artisan` and we will find the `make:crud` command, it will create simple Laravel CRUD files of given **model name**.
#### Available Commands
```bash
# For example we want to create CRUD for 'App\Vehicle' model.
# Create Full CRUD feature with tests
$ php artisan make:crud
# Create API CRUD feature with tests
$ php artisan make:crud-api
# Create Simple CRUD feature with tests
$ php artisan make:crud-simple
```
For example we want to create CRUD for '**App\Vehicle**' model.
```bash
$ php artisan make:crud Vehicle
Vehicle resource route generated on routes/web.php.
@ -94,6 +107,20 @@ $ php artisan serve
Then visit our application url: `http://localhost:8000/vehicles`.
#### For API
If we want to generate API Controller with feature tests, we use following command :
```bash
$ php artisan make:crud-api Vehicle
```
By default, we use Laravel Token Based Authentication, so we need to update our user model.
1. Add `api_token` as **fillable** property on **User model**.
2. Add `api_token` **field** on our **UserFactory**.
3. Add `api_token` **column** on our **users_table_migration**.
## Config file
By default, this package have some configuration:

Loading…
Cancel
Save