Skip to content

Commit b57258d

Browse files
authored
Merge pull request #51 from milwad-dev/milwad-dev-patch-1
Update README.md
2 parents a076290 + 3ef22d7 commit b57258d

1 file changed

Lines changed: 24 additions & 23 deletions

File tree

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
***
1212
Laravel crod is a package for implementing CRUD faster and easier.
13-
You can quickly create controllers, models, migrations, services, repositories, views and requests.
13+
You can quickly create controllers, models, migrations, services, repositories, views, and requests.
1414
You can make it automatically fillable for models, query for repositories and services, make resource controllers, and have a lot of options.
1515

1616
Docs: https://github.com/milwad-dev/laravel-crod/wiki
@@ -23,13 +23,14 @@ Docs: https://github.com/milwad-dev/laravel-crod/wiki
2323
- `Laravel framework: ^9`
2424
- `doctrine/dbal: ^3.6`
2525

26-
| Crod | L7 | L8 | L9 | L10 | L11 |
27-
|------|--------------------|--------------------|--------------------|--------------------|--------------------|
28-
| 1.0 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
29-
| 1.1 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
30-
| 1.2 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
31-
| 1.3 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
32-
| 1.4 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
26+
| Crod | L7 | L8 | L9 | L10 | L11 | L12 |
27+
|------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|
28+
| 1.0 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: | :x: |
29+
| 1.1 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
30+
| 1.2 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
31+
| 1.3 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
32+
| 1.4 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
33+
| 1.5 | :x: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
3334

3435
## Installation
3536

@@ -73,25 +74,25 @@ php artisan crud:make Product
7374

7475
When you execute this command, after creating the files, you will see a list of options that will create a series of additional files for you, which of course are optional, you can choose and if you need, it will create additional files for you such as `seeder`, `factory`, `repository`, etc.
7576

76-
✅ After, you can see `Laravel Crod` creates crud files such as `Model`, `Controller`, `Form-Requests`, `Migrations` etc.
77+
✅ After, you can see `Laravel Crod` creates crud files such as `Model`, `Controller`, `Form-Requests`, `Migrations`, etc.
7778

7879
## CRUD Query
7980

80-
If you run `crud:query` command, the result is:
81+
If you run the `crud:query` command, the result is:
8182

82-
- Add `index`, `create`, `store`, `edit`, `update`, `destroy` function to your controller
83-
- Get all migration columns and move it to your model fillable
84-
- Add `index`, `findById`, `delete` functions to your repositories
83+
- Add `index`, `create`, `store`, `edit`, `update`, `destroy` functions to your controller
84+
- Get all migration columns and move them to your model fillable
85+
- Add `index`, `findById`, and `delete` functions to your repositories
8586
- Add `store`, `update` functions to your services
8687
- Add resource route (SOON)
8788

88-
<strong>** You must run the migrate command, before `crud:query` command. ** </strong> <br>
89+
<strong>** You must run the migrate command before the `crud:query` command. ** </strong> <br>
8990

9091
```bash
9192
php artisan migrate
9293
```
9394

94-
For using automatic query, you can run below command:
95+
For using the automatic query, you can run below command:
9596

9697
```bash
9798
php artisan crud:query {table_name} {model} {--id-controller}
@@ -103,13 +104,13 @@ For example:
103104
php artisan crud:query products Product
104105
```
105106

106-
When you add `--id-controller` option, the `Laravel Crod` create crud functions without [Route Model Binding](https://laravel.com/docs/routing#route-model-binding) in controller.
107+
When you add `--id-controller` option, the `Laravel Crod` creates crud functions without [Route Model Binding](https://laravel.com/docs/routing#route-model-binding) in the controller.
107108

108109
After you can see `Laravel Crod` added query to service, repository, controller, model, etc.
109110

110111
## CRUD for Module
111112

112-
If you are using Modular Architecture, you are able to run `crud:make-module` command. This command create a new module and create the default crud files such as `Model`, `Controller`, `Migration`, etc:
113+
If you are using Modular Architecture, you can run the `crud:make-module` command. This command creates a new module and creates the default CRUD files such as `Model`, `Controller`, `Migration`, etc:
113114

114115
```bash
115116
php artisan crud:make-module {module_name}
@@ -125,8 +126,8 @@ When you execute this command, after creating the files, you will see a list of
125126

126127
## CRUD Query for Module
127128

128-
This command adds query and date to CRUD files for module.
129-
This command is similar to `crud:query` command, but this command is for module. if you have a modular you can write your module name and `Laravel Crod` find it automatically.
129+
This command adds a query and a date to the CRUD files for the module.
130+
This command is similar to the `crud:query` command, but this command is for the module. If you have a module, you can write your module name and `Laravel Crod` find it automatically.
130131

131132
** You must run your migration file **
132133

@@ -146,15 +147,15 @@ OR
146147
php artisan crud:query-module products Product --id-controller
147148
```
148149

149-
When you add `--id-controller` option, the `Laravel Crod` create crud functions without [Route Model Binding](https://laravel.com/docs/routing#route-model-binding) in controller.
150+
When you add `--id-controller` option, the `Laravel Crod` creates crud functions without [Route Model Binding](https://laravel.com/docs/routing#route-model-binding) in the controller.
150151

151152
After you can see `Laravel Crod` added query to service, repository, controller, model, ... for your module.
152153

153154
## Custom path
154155

155-
You can custom file path in config file. ``````
156+
You can customize the file path in a config file. ``````
156157

157-
With `Laravel Crod` config, you can customize the commands, for example you want to set the route file name.
158+
With `Laravel Crod` config, you can customize the commands, for example, you want to set the route file name.
158159
This config file exists in `config/laravel-crod.php`:
159160

160161
```php
@@ -262,7 +263,7 @@ contribute. [CONTRIBUTING](https://github.com/milwad-dev/laravel-crod/graphs/con
262263

263264
## Security
264265

265-
If you've found a bug regarding security please mail [milwad.dev@gmail.com](mailto:milwad.dev@gmail.com) instead of
266+
If you've found a bug regarding security, please email [milwad.dev@gmail.com](mailto:milwad.dev@gmail.com) instead of
266267
using the issue tracker.
267268

268269
## Conclusion

0 commit comments

Comments
 (0)