From 6d51ef423a056baffa05629fbc9d70eb279f2f8a Mon Sep 17 00:00:00 2001 From: Mohammad Zulfahmi Date: Sat, 25 Feb 2023 16:50:57 +0700 Subject: [PATCH 1/2] Update composer.json --- composer.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index 20afc8f..7de5571 100644 --- a/composer.json +++ b/composer.json @@ -17,13 +17,13 @@ }, "require-dev": { "barryvdh/laravel-debugbar": "^3.6", + "evdigiina/generator": "dev-dev", "fakerphp/faker": "^1.9.1", "laravel/sail": "^1.0.1", "mockery/mockery": "^1.4.4", "nunomaduro/collision": "^6.1", "phpunit/phpunit": "^9.5.10", - "spatie/laravel-ignition": "^1.0", - "zzzul/generator": "^0.1.1" + "spatie/laravel-ignition": "^1.0" }, "autoload": { "psr-4": { From d40e3b323a5a65fe975011ebd2900bba00e44957 Mon Sep 17 00:00:00 2001 From: Mohammad Zulfahmi Date: Sat, 25 Feb 2023 16:54:01 +0700 Subject: [PATCH 2/2] Update README.md --- README.md | 210 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 131 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index ef5e510..39156d3 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,174 @@ + https://user-images.githubusercontent.com/62506582/200510814-9b2ca922-bd35-4e02-a236-047c4b7b118d.mp4 -

Laravel starter app and CRUD generator.

- -
- +

Laravel starter app and CRUD generator.

+ +
+ [![All Contributors](https://img.shields.io/github/contributors/Zzzul/generator?style=flat-square)](https://github.com/Zzzul/generator/graphs/contributors) ![GitHub last commit](https://img.shields.io/github/last-commit/Zzzul/generator.svg?style=flat-square) [![License](https://img.shields.io/github/license/Zzzul/generator.svg?style=flat-square)](LICENSE) [![Issues](https://img.shields.io/github/issues/Zzzul/generator?style=flat-square)](Issues) [![Forks](https://img.shields.io/github/forks/Zzzul/generator?style=flat-square)](Forks) [![Stars](https://img.shields.io/github/stars/Zzzul/generator?style=flat-square)](Stars) - +
## Table of Contents + 1. [Requirements](#requirements) -2. [What's inside?](#what-inside) -3. [Features](#features) -4. [Setup](#setup) -5. [Usage](#usage) -6. [License](#license) -7. [Support](#support) +2. [Setup](#setup) +3. [What's inside?](#what-inside) +4. [Features](#features) +5. [License](#license) +6. [Contributors](#contributors) ## Requirements + - [PHP ^8.1](https://www.php.net/releases/8.1/en.php) +- [Laravel ^9.x](https://laravel.com/) -

What's inside?

+ +## Setup -- [Laravel - ^9.x](https://laravel.com/) -- [Laravel Forify - ^1.x](https://laravel.com/docs/9.x/fortify) -- [Laravel Debugbar - ^3.x](https://github.com/barryvdh/laravel-debugbar) -- [Spatie permission - ^5.x](https://github.com/spatie/laravel-permission) -- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation) -- [Intervention Image - ^2.x](https://image.intervention.io/v2) -- [Mazer template - ^2.x](https://github.com/zuramai/mazer/) -- [Generator - ^0.1.x](https://github.com/Zzzul/generator-src/) +Installation -## Features -- [x] Authentication ([Laravel Fortify](https://laravel.com/docs/9.x/fortify)) - - Login - - Register - - Forgot Password - - 2FA Authentication - - Update profile information -- [x] Roles and permissions ([Spatie Permission](https://spatie.be/docs/laravel-permission/v5/introduction)) -- [x] CRUD User -- [x] CRUD Generator - - Support more than [15 column type migration](https://laravel.com/docs/9.x/migrations#available-column-types), like string, char, date, year, etc. - - Datatables ([Yajra datatables](https://github.com/yajra/laravel-datatables)) - - BelongsTo relation - - Model casting - - Image upload ([Intervention Image](https://image.intervention.io/v2)) - - Support [HTML 5 Input](https://developer.mozilla.org/en-US/docs/Learn/Forms/HTML5_input_types) - - Request validations supported: - - required, in, image, min, max, string, email, number, date, exists, nullable, unique, comfirmed +```sh -## Setup -1. Clone or download from [Releases](https://github.com/Zzzul/generator/releases) -```bash -git clone https://github.com/Zzzul/generator.git -``` +composer require evdigiina/generator:dev-dev --dev -2. CD into `/generator` -```shell -cd generator ``` -3. Install Laravel dependency -```shell -composer install +#### For this package, there are two variations: [Simpe Version](#simple-version) and [Full Version](#full-version) + +

Simple Version

+ + ![image](https://user-images.githubusercontent.com/62506582/219941448-94c46fca-6a9f-422b-bdd1-29f642c3ccf6.png) + + +Only the generator, includes: [Yajra Datatables](https://yajrabox.com/docs/laravel-datatables/master/installation), [Intervention Image](https://image.intervention.io/v2), and [Bootstrap 5](https://getbootstrap.com/). + +##### [View all features](#simple-features) + +#### Usage + +Publish assets + +```sh +php artisan generator:install simple ``` -4. Create copy of ```.env``` -```shell -cp .env.example .env + Register the provider in `config/app.php` +```php +/* +* Package Service Providers... +*/ +App\Providers\ViewComposerServiceProvider::class, ``` + +Then goes to ```/simple-generators/create/``` + +
+ +

Full Version

+ +![image](https://user-images.githubusercontent.com/62506582/219942571-63c42764-1702-4df3-b165-4217e5558713.png) + +The generator + starter app, includes: [Yajra Datatables](https://yajrabox.com/docs/laravel-datatables/master/installation), [Intervention Image](https://image.intervention.io/v2), [Laravel Fortify](https://laravel.com/docs/9.x/fortify), [Spatie Permission](https://spatie.be/docs/laravel-permission/v5/installation-laravel), and [Mazer Template](https://github.com/zuramai/mazer). -5. Generate laravel key -```shell -php artisan key:generate +##### [View all features](#full-features). + + +> Installing this package after a brand-new Laravel installation is necessary if you want to use the full version of it. because several files will be overwritten. + + +#### Install [Laravel Fortify](https://laravel.com/docs/9.x/fortify) & [Spatie Permission](https://spatie.be/docs/laravel-permission/v5/installation-laravel) + +```sh +composer require laravel/fortify spatie/laravel-permission ``` -6. Set database name and account in ```.env``` -```shell -DB_DATABASE=generator -DB_USERNAME=root -DB_PASSWORD= +#### Usage + +Publish assets + +```sh +php artisan generator:install full ``` -7. Run Laravel migrate and seeder -```shell -php artisan migrate --seed -``` +> Warning! Be careful with this command, it will overwrite several files, don't run it multiple times. + + +Register the provider in `config/app.php` +```php +/* +* Package Service Providers... +*/ +App\Providers\FortifyServiceProvider::class, +Spatie\Permission\PermissionServiceProvider::class, +App\Providers\ViewComposerServiceProvider::class, +``` + -8. Create the symbolic link -```shell -php artisan storage:link -``` +Run migration and seeder -9. Start development server -```shell -php artisan serve -``` +```sh +php artisan migrate --seed +``` -## Usage -Go to ```/generators/create``` +Then goes to ```/generators/create``` Account - Email: admin@example.com - Password: password + +

What's inside?

+ +#### Simple Version + +- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation) +- [Intervention Image - ^2.x](https://image.intervention.io/v2) +- [Bootstrap - ^5.x](https://getbootstrap.com/) + +#### Full Version + +- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation) +- [Intervention Image - ^2.x](https://image.intervention.io/v2) +- [Laravel Forify - ^1.x](https://laravel.com/docs/9.x/fortify) +- [Spatie permission - ^5.x](https://github.com/spatie/laravel-permission) +- [Mazer template - ^2.x](https://github.com/zuramai/mazer/) + +## Features + +

Simple Version

+ +- [x] CRUD Generator + - Support more than 15 [column types of migrations](https://laravel.com/docs/9.x/migrations#available-column-types), like string, char, date, year, etc. + - Datatables ([Yajra Datatables](https://github.com/yajra/laravel-datatables)) + - BelongsTo relation + - Model casting + - Image upload ([Intervention Image](https://image.intervention.io/v2)) + - Support [HTML 5 Input](https://developer.mozilla.org/en-US/docs/Learn/Forms/HTML5_input_types) + - Request validations supported: required, in, image, min, max, string, email, number, date, exists, nullable, unique, comfirmed + +

Full Version

+ +- [x] CRUD Generator +- [x] CRUD User +- [x] Roles and permissions ([Spatie Permission](https://spatie.be/docs/laravel-permission/v5/introduction)) +- [x] Authentication ([Laravel Fortify](https://laravel.com/docs/9.x/fortify)) + - Login + - Register + - Forgot Password + - 2FA Authentication + - Update profile information ## License [MIT License](./LICENSE) + -## Support - -Buy Me A Coffee +## Contributors + + - -Or you can support me at [Ko-fi](https://ko-fi.com/mzulfahmi) or [Saweria](https://saweria.co/zzzul)