-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from Zzzul/development
Update composer.json & README.md
- Loading branch information
Showing
2 changed files
with
133 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,122 +1,174 @@ | ||
|
|
||
|
|
||
| https://user-images.githubusercontent.com/62506582/200510814-9b2ca922-bd35-4e02-a236-047c4b7b118d.mp4 | ||
|
|
||
| <p align="center">Laravel starter app and CRUD generator.</p> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| <p align="center">Laravel starter app and CRUD generator.</p> | ||
| <div align="center"> | ||
| [](https://github.com/Zzzul/generator/graphs/contributors) | ||
|  | ||
| [](LICENSE) | ||
| [](Issues) | ||
| [](Forks) | ||
| [](Stars) | ||
|
|
||
| </div> | ||
|
|
||
| ## 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/) | ||
|
|
||
| <h2 id="what-inside">What's inside?</h2> | ||
|
|
||
| ## 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) | ||
|
|
||
| <h3 id="simple-version">Simple Version</h3> | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 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/``` | ||
|
|
||
| <hr> | ||
|
|
||
| <h3 id="full-version">Full Version</h3> | ||
|
|
||
|  | ||
|
|
||
| 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: [email protected] | ||
| - Password: password | ||
|
|
||
| <h2 id="what-inside">What's inside?</h2> | ||
|
|
||
| #### 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 | ||
|
|
||
| <h3 id="simple-features">Simple Version</h3> | ||
|
|
||
| - [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 | ||
|
|
||
| <h3 id="full-features">Full Version</h3> | ||
|
|
||
| - [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 | ||
| <a href="https://www.buymeacoffee.com/mzulfahmi" target="_blank"> | ||
| <img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;"> | ||
| ## Contributors | ||
| <a href="https://github.com/Zzzul/generator/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=Zzzul/generator&anon=1&columns=10" /> | ||
| </a> | ||
|
|
||
| Or you can support me at [Ko-fi](https://ko-fi.com/mzulfahmi) or [Saweria](https://saweria.co/zzzul) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters