Skip to content

Commit 4e027a6

Browse files
ZzzulZzzul
authored
Update README.md
1 parent c89ee16 commit 4e027a6

1 file changed

Lines changed: 79 additions & 131 deletions

File tree

‎README.md‎

Lines changed: 79 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,174 +1,122 @@
11

2-
32
https://user-images.githubusercontent.com/62506582/200510814-9b2ca922-bd35-4e02-a236-047c4b7b118d.mp4
43

5-
<p align="center">Laravel starter app and CRUD generator.</p>
6-
7-
<div align="center">
8-
4+
<p align="center">Laravel starter app and CRUD generator.</p>
5+
6+
<div align="center">
7+
98
[![All Contributors](https://img.shields.io/github/contributors/Zzzul/generator?style=flat-square)](https://github.com/Zzzul/generator/graphs/contributors)
109
![GitHub last commit](https://img.shields.io/github/last-commit/Zzzul/generator.svg?style=flat-square)
1110
[![License](https://img.shields.io/github/license/Zzzul/generator.svg?style=flat-square)](LICENSE)
1211
[![Issues](https://img.shields.io/github/issues/Zzzul/generator?style=flat-square)](Issues)
1312
[![Forks](https://img.shields.io/github/forks/Zzzul/generator?style=flat-square)](Forks)
1413
[![Stars](https://img.shields.io/github/stars/Zzzul/generator?style=flat-square)](Stars)
15-
14+
1615
</div>
1716

1817
## Table of Contents
19-
2018
1. [Requirements](#requirements)
21-
2. [Setup](#setup)
22-
3. [What's inside?](#what-inside)
23-
4. [Features](#features)
24-
5. [License](#license)
25-
6. [Contributors](#contributors)
19+
2. [What's inside?](#what-inside)
20+
3. [Features](#features)
21+
4. [Setup](#setup)
22+
5. [Usage](#usage)
23+
6. [License](#license)
24+
7. [Support](#support)
2625

2726
## Requirements
28-
2927
- [PHP ^8.1](https://www.php.net/releases/8.1/en.php)
30-
- [Laravel ^9.x](https://laravel.com/)
31-
32-
33-
## Setup
3428

35-
Installation
29+
<h2 id="what-inside">What's inside?</h2>
3630

37-
```sh
31+
- [Laravel - ^9.x](https://laravel.com/)
32+
- [Laravel Forify - ^1.x](https://laravel.com/docs/9.x/fortify)
33+
- [Laravel Debugbar - ^3.x](https://github.com/barryvdh/laravel-debugbar)
34+
- [Spatie permission - ^5.x](https://github.com/spatie/laravel-permission)
35+
- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation)
36+
- [Intervention Image - ^2.x](https://image.intervention.io/v2)
37+
- [Mazer template - ^2.x](https://github.com/zuramai/mazer/)
38+
- [Generator - ^0.1.x](https://github.com/Zzzul/generator-src/)
3839

39-
composer require evdigiina/generator:dev-dev --dev
40+
## Features
41+
- [x] Authentication ([Laravel Fortify](https://laravel.com/docs/9.x/fortify))
42+
- Login
43+
- Register
44+
- Forgot Password
45+
- 2FA Authentication
46+
- Update profile information
47+
- [x] Roles and permissions ([Spatie Permission](https://spatie.be/docs/laravel-permission/v5/introduction))
48+
- [x] CRUD User
49+
- [x] CRUD Generator
50+
- Support more than [15 column type migration](https://laravel.com/docs/9.x/migrations#available-column-types), like string, char, date, year, etc.
51+
- Datatables ([Yajra datatables](https://github.com/yajra/laravel-datatables))
52+
- BelongsTo relation
53+
- Model casting
54+
- Image upload ([Intervention Image](https://image.intervention.io/v2))
55+
- Support [HTML 5 Input](https://developer.mozilla.org/en-US/docs/Learn/Forms/HTML5_input_types)
56+
- Request validations supported:
57+
- required, in, image, min, max, string, email, number, date, exists, nullable, unique, comfirmed
4058

59+
## Setup
60+
1. Clone or download from [Releases](https://github.com/Zzzul/generator/releases)
61+
```bash
62+
git clone https://github.com/Zzzul/generator.git
4163
```
4264

43-
#### For this package, there are two variations: [Simpe Version](#simple-version) and [Full Version](#full-version)
44-
45-
<h3 id="simple-version">Simple Version</h3>
46-
47-
![image](https://user-images.githubusercontent.com/62506582/219941448-94c46fca-6a9f-422b-bdd1-29f642c3ccf6.png)
48-
49-
50-
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/).
51-
52-
##### [View all features](#simple-features)
53-
54-
#### Usage
55-
56-
Publish assets
57-
58-
```sh
59-
php artisan generator:install simple
65+
2. CD into `/generator`
66+
```shell
67+
cd generator
6068
```
6169

62-
Register the provider in `config/app.php`
63-
```php
64-
/*
65-
* Package Service Providers...
66-
*/
67-
App\Providers\ViewComposerServiceProvider::class,
70+
3. Install Laravel dependency
71+
```shell
72+
composer install
6873
```
69-
70-
Then goes to ```/simple-generators/create/```
71-
72-
<hr>
73-
74-
<h3 id="full-version">Full Version</h3>
75-
76-
![image](https://user-images.githubusercontent.com/62506582/219942571-63c42764-1702-4df3-b165-4217e5558713.png)
77-
78-
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).
7974

80-
##### [View all features](#full-features).
81-
82-
83-
> 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.
84-
85-
86-
#### Install [Laravel Fortify](https://laravel.com/docs/9.x/fortify) & [Spatie Permission](https://spatie.be/docs/laravel-permission/v5/installation-laravel)
87-
88-
```sh
89-
composer require laravel/fortify spatie/laravel-permission
75+
4. Create copy of ```.env```
76+
```shell
77+
cp .env.example .env
9078
```
9179

92-
#### Usage
93-
94-
Publish assets
95-
96-
```sh
97-
php artisan generator:install full
80+
5. Generate laravel key
81+
```shell
82+
php artisan key:generate
9883
```
9984

100-
> Warning! Be careful with this command, it will overwrite several files, don't run it multiple times.
101-
102-
103-
Register the provider in `config/app.php`
104-
```php
105-
/*
106-
* Package Service Providers...
107-
*/
108-
App\Providers\FortifyServiceProvider::class,
109-
Spatie\Permission\PermissionServiceProvider::class,
110-
App\Providers\ViewComposerServiceProvider::class,
85+
6. Set database name and account in ```.env```
86+
```shell
87+
DB_DATABASE=generator
88+
DB_USERNAME=root
89+
DB_PASSWORD=
11190
```
112-
113-
114-
Run migration and seeder
11591

116-
```sh
92+
7. Run Laravel migrate and seeder
93+
```shell
11794
php artisan migrate --seed
118-
```
95+
```
96+
97+
8. Create the symbolic link
98+
```shell
99+
php artisan storage:link
100+
```
119101

120-
Then goes to ```/generators/create```
102+
9. Start development server
103+
```shell
104+
php artisan serve
105+
```
106+
107+
## Usage
108+
Go to ```/generators/create```
121109

122110
Account
123111
- Email: admin@example.com
124112
- Password: password
125-
126-
<h2 id="what-inside">What's inside?</h2>
127-
128-
#### Simple Version
129-
130-
- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation)
131-
- [Intervention Image - ^2.x](https://image.intervention.io/v2)
132-
- [Bootstrap - ^5.x](https://getbootstrap.com/)
133-
134-
#### Full Version
135-
136-
- [Yajra datatable - ^10.x](https://yajrabox.com/docs/laravel-datatables/master/installation)
137-
- [Intervention Image - ^2.x](https://image.intervention.io/v2)
138-
- [Laravel Forify - ^1.x](https://laravel.com/docs/9.x/fortify)
139-
- [Spatie permission - ^5.x](https://github.com/spatie/laravel-permission)
140-
- [Mazer template - ^2.x](https://github.com/zuramai/mazer/)
141-
142-
## Features
143-
144-
<h3 id="simple-features">Simple Version</h3>
145-
146-
- [x] CRUD Generator
147-
- Support more than 15 [column types of migrations](https://laravel.com/docs/9.x/migrations#available-column-types), like string, char, date, year, etc.
148-
- Datatables ([Yajra Datatables](https://github.com/yajra/laravel-datatables))
149-
- BelongsTo relation
150-
- Model casting
151-
- Image upload ([Intervention Image](https://image.intervention.io/v2))
152-
- Support [HTML 5 Input](https://developer.mozilla.org/en-US/docs/Learn/Forms/HTML5_input_types)
153-
- Request validations supported: required, in, image, min, max, string, email, number, date, exists, nullable, unique, comfirmed
154-
155-
<h3 id="full-features">Full Version</h3>
156-
157-
- [x] CRUD Generator
158-
- [x] CRUD User
159-
- [x] Roles and permissions ([Spatie Permission](https://spatie.be/docs/laravel-permission/v5/introduction))
160-
- [x] Authentication ([Laravel Fortify](https://laravel.com/docs/9.x/fortify))
161-
- Login
162-
- Register
163-
- Forgot Password
164-
- 2FA Authentication
165-
- Update profile information
166113

167114
## License
168115
[MIT License](./LICENSE)
169-
170116

171-
## Contributors
172-
<a href="https://github.com/Zzzul/generator/graphs/contributors">
173-
<img src="https://contrib.rocks/image?repo=Zzzul/generator&anon=1&columns=10" />
117+
## Support
118+
<a href="https://www.buymeacoffee.com/mzulfahmi" target="_blank">
119+
<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;">
174120
</a>
121+
122+
Or you can support me at [Ko-fi](https://ko-fi.com/mzulfahmi) or [Saweria](https://saweria.co/zzzul)

0 commit comments

Comments
 (0)