diff --git a/readme.md b/readme.md index f8c96a9..a0c5062 100644 --- a/readme.md +++ b/readme.md @@ -15,8 +15,16 @@ With this package installed on local environment, we can use (e.g.) `php artisan - **ManageItemsTest.php** feature test class in `tests/Feature` directory - **ItemTest.php** unit test class in `tests/Unit/Models` directory +The model will only have 2 pre-definded attributes or columns : `name` and `description` on each model and database table. + +## Attention +- This package still in development +- Use this package on new Laravel project for simulation. +- It will creates the **Model** class file, don't use it to generate files for existing **Model** class. +- You need a `resources/views/layouts/app.blade.php` view file, simply create one with `php artisan make:auth` command. + ## How to install -On `composer.json` file, Add this : +This package has not been submitted to packagist, so we can use github repo as additional repository. To have the additional repository, we do some configiration on `composer.json` file, add this : ```json "repositories": [ @@ -29,11 +37,13 @@ On `composer.json` file, Add this : then ```bash +# Bootstrap Form Field generator +$ composer require luthfi/formfield + +# Get the package $ composer require luthfi/simple-crud-generator dev-master --dev ``` -> **Note:** this package still in development - ## How to use The package will **auto-discovered** in **Laravel 5.5**. Just type in terminal: @@ -42,7 +52,6 @@ $ php artisan ``` We will find the `make:crud` command, it will `Create simple Laravel CRUD files of given model name`. -**Note: It also creates the model class file**. ```bash $ php artisan make:crud Item @@ -58,4 +67,39 @@ BrowserKitTest generated. ManageItemsTest generated. ItemTest (model) generated. CRUD files generated successfully! -``` \ No newline at end of file +``` + +Create mysql database, set your database credential on `.env` file. Then : + +```bash +$ php artisan migrate +``` + +Visit your application in new resource route : `http://127.0.0.1:8000/items` + +The CRUD function should work. + +Next, to use the generated testing classes, we can set the database environment using in-memory database SQLite. Open `phpunit.xml`. Add two lines below on the `env` : + +```xml + + + + + + + + +``` + +Try out the generated testing classes via terminal. + +```bash +$ vendor/bin/phpunit +``` + +All tests should be passed. + +## License + +This package is open-sourced software licensed under the [MIT license](LICENSE).