Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@MikeAlhayek
MikeAlhayek committed Jan 28, 2024
1 parent 01eaa53 commit bf0c5ed
Showing 1 changed file with 93 additions and 111 deletions.
204 changes: 93 additions & 111 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,33 @@

An intelligent code generator for Laravel framework that will save you time! This awesome tool will help you generate resources like views, controllers, routes, migrations, languages and/or form-requests! It is extremely flexible and customizable to cover many on the use cases. It is shipped with cross-browsers compatible template, along with a client-side validation to modernize your application.

For full documentation and live demo please visit <a href="https://crestapps.com/laravel-code-generator/docs/2.3" target="_blank" title="Laravel Code Generator Documentation">CrestApps.com</a>

**Note: ** The available documentation is for versions <= 2.2. The documentation for version 2.3+ is very similar with some exceptions. Please review the <a href="https://github.com/CrestApps/laravel-code-generator/blob/master/CHANGELOG.md" title="ChangeLog">Change Log</a> to get a list of the changes.
For full documentation and live demo please visit <a href="https://laravel-code-generator.crestapps.com" target="_blank" title="Laravel Code Generator Documentation">CrestApps.com</a>

## Features

<ul>
<li>One step installation when using Laravel 5.5+</li>
<li>Create very clean, reusable and highly readable code to build on.</li>
<li>Create full resources using a single command with <strong>migration</strong> or from <strong>existing database</strong>.</li>
<li>Creates full resources for all of the existing tables in the database using one command.</li>
<li>Create full API-based resources using a single command with <strong>migration</strong> or from <strong>existing database</strong>.</li>
<li>Create beautiful documentation for your API.</li>
<li>Create api-resource and api-resource-collection with Laravel 5.5+.</li>
<li>Allows you to save the fields in a JSON file and recreate resources when the business needs changes.</li>
<li>Utilizes JSON based resource-file to allow you to define your resources. Resource-file allows you to easily regenerate the resource at any time even when the business rules change.</li>
<li>Create standard CRUD controllers with simple or form-request validation.</li>
<li>Customizable view templates to enable you to change the standard look and feel of your application.</li>
<li>Create model with relations.</li>
<li>Create named routes with and without group.</li>
<li>Create standard CRUD views.</li>
<li>Smart migration engine! Keeps track of all generated migrations to only create the needed migration.</li>
<li>Intelligent enough to automatically handles the relations between the models.</li>
<li>Very flexible and rich with configurable options.</li>
<li>Easy commands to create resource-file; additionally, add or reduce existing resource-file.</li>
<li>Full capability to generate multi-languages applications.</li>
<li>Client-side validation.</li>
<li>File uploading handling.</li>
<li>Auto store multiple-response in the database.</li>
<li>Create form-request to clean up your controller and increase your code re-usability.</li>
<li>Create view's layouts with and without client-side validation.</li>
<li>Change the template at run time to generate different views.</li>
<li>Ability to generate views with and without Laravel-Collective.</li>
<li>Nicely handles any date, time or DateTime field.</li>
<li>Auto handles any boolean field.</li>
<li>Very easy to use with lots of documentation.</li>
</ul>
- Craft clean, reusable, and highly readable code for seamless development.
- Generate complete resources effortlessly with a single command, supporting both migration and existing database scenarios.
- Streamline resource creation for all existing database tables with a single command.
- Save and recreate fields using a JSON file, ensuring adaptability to changing business needs.
- Leverage JSON-based resource files for easy regeneration, even when business rules evolve.
- Generate standard CRUD controllers with simple or form-request validation.
- Customize view templates to alter the standard look and feel of your application.
- Create models with relations for comprehensive data representation.
- Establish named routes with and without grouping for efficient navigation.
- Generate standard CRUD views to facilitate a consistent user experience.
- Smart migration engine tracks generated migrations to only create necessary ones.
- Intelligent handling of model relations to simplify development.
- Highly flexible with rich configurable options to suit diverse needs.
- Easy commands for resource-file creation, addition, or reduction.
- Full support for generating multi-language applications.
- Implement client-side validation for enhanced user interaction.
- Efficiently handle file uploading and store multiple responses in the database.
- Generate form-request to clean up controllers and boost code reusability.
- Create view layouts with and without client-side validation.
- Change templates at runtime for diverse view generation.
- Ability to generate views with or without Laravel-Collective integration.
- Seamless handling of date, time, or datetime fields.
- Automatic management of boolean fields for hassle-free development.

## Installation

Expand All @@ -61,8 +51,6 @@ For full documentation and live demo please visit <a href="https://crestapps.com
}
```

> A layout is required for the default views! The code generator allows you to create a layout using the command-line. Of course you can use your own layout. You'll only need to include [CSS bootstrap framework](http://getbootstrap.com/ "CSS bootstrap framework") in your layout for the default templates to work properly. Additionally, you can chose to you design your own templates using a different or no css framework.
## Lessons
Checkout our channel on <a href="https://www.youtube.com/channel/UCkEd0nOoRf3o0ahspAu7Y9w/videos" target="_blank" title="CrestApps YouTube Channel">YouTube.com</a>
* https://youtu.be/l21qNcsMAWg
Expand All @@ -74,84 +62,80 @@ Checkout our channel on <a href="https://www.youtube.com/channel/UCkEd0nOoRf3o0a
> The command in between the square brackets **[]** must be replaced with a variable of your choice.
<ul>
<li>
<strong>Main commands</strong>
<ul>
<li>php artisan create:scaffold [model-name]</li>
<li>php artisan create:controller [model-name]</li>
<li>php artisan create:model [model-name]</li>
<li>php artisan create:form-request [model-name]</li>
<li>php artisan create:routes [model-name]</li>
<li>php artisan create:migration [model-name]</li>
<li>php artisan create:language [model-name]</li>
<li>php artisan create:mapped-resources</li>
</ul>
</li>
<li>
<strong>API commands</strong>
<ul>
<li>php artisan create:api-scaffold [model-name]</li>
<li>php artisan create:api-controller [model-name]</li>
<li>php artisan create:api-resources [model-name]</li>
</ul>
</li>
<li>
<strong>API Documentations commands</strong>
<ul>
<li>php artisan api-docs:scaffold [model-name]</li>
<li>php artisan api-doc:create-controller [model-name]</li>
<li>php artisan api-doc:create-view [model-name]</li>
</ul>
</li>
<li>
<strong>Views commands</strong>
<ul>
<li>php artisan create:layout [application-name]</li>
<li>php artisan create:views [model-name]</li>
<li>php artisan create:index-view [model-name]</li>
<li>php artisan create:create-view [model-name]</li>
<li>php artisan create:edit-view [model-name]</li>
<li>php artisan create:show-view [model-name]</li>
<li>php artisan create:form-view [model-name]</li>
</ul>
</li>
<li>
<strong>Resource's files commands</strong>
<ul>
<li>php artisan resource-file:from-database [model-name]</li>
<li>php artisan resource-file:create [model-name]</li>
<li>php artisan resource-file:append [model-name]</li>
<li>php artisan resource-file:reduce [model-name]</li>
<li>php artisan resource-file:delete [model-name]</li>
</ul>
</li>
<li>
<strong>Migration commands</strong>
<ul>
<li>php artisan migrate-all</li>
<li>php artisan migrate:rollback-all</li>
<li>php artisan migrate:reset-all</li>
<li>php artisan migrate:refresh-all</li>
<li>php artisan migrate:status-all</li>
</ul>
</li>
<li>
<strong>Main commands</strong>
<ul>
<li>php artisan create:scaffold [model-name]</li>
<li>php artisan create:controller [model-name]</li>
<li>php artisan create:model [model-name]</li>
<li>php artisan create:form-request [model-name]</li>
<li>php artisan create:routes [model-name]</li>
<li>php artisan create:migration [model-name]</li>
<li>php artisan create:language [model-name]</li>
<li>php artisan create:mapped-resources</li>
</ul>
</li>
<li>
<strong>API commands</strong>
<ul>
<li>php artisan create:api-scaffold [model-name]</li>
<li>php artisan create:api-controller [model-name]</li>
<li>php artisan create:api-resources [model-name]</li>
</ul>
</li>
<li>
<strong>API Documentations commands</strong>
<ul>
<li>php artisan api-docs:scaffold [model-name]</li>
<li>php artisan api-doc:create-controller [model-name]</li>
<li>php artisan api-doc:create-view [model-name]</li>
</ul>
</li>
<li>
<strong>Views commands</strong>
<ul>
<li>php artisan create:layout [application-name]</li>
<li>php artisan create:views [model-name]</li>
<li>php artisan create:index-view [model-name]</li>
<li>php artisan create:create-view [model-name]</li>
<li>php artisan create:edit-view [model-name]</li>
<li>php artisan create:show-view [model-name]</li>
<li>php artisan create:form-view [model-name]</li>
</ul>
</li>
<li>
<strong>Resource's files commands</strong>
<ul>
<li>php artisan resource-file:from-database [model-name]</li>
<li>php artisan resource-file:create [model-name]</li>
<li>php artisan resource-file:append [model-name]</li>
<li>php artisan resource-file:reduce [model-name]</li>
<li>php artisan resource-file:delete [model-name]</li>
</ul>
</li>
<li>
<strong>Migration commands</strong>
<ul>
<li>php artisan migrate-all</li>
<li>php artisan migrate:rollback-all</li>
<li>php artisan migrate:reset-all</li>
<li>php artisan migrate:refresh-all</li>
<li>php artisan migrate:status-all</li>
</ul>
</li>
</ul>

> Full documentation available at [CrestApps.com](https://www.crestapps.com/laravel-code-generator/docs/2.3 "Laravel Code Generator Documentation").

> Live demo is available at [CrestApps.com](https://www.crestapps.com/laravel-code-generator/demos/v2-3 "Laravel Code Generator Live Demo").
## Contribution

## Upgrading from version <= 2.2 to 2.3+
- Delete the `codegenerator.php` file found in your `config` folder, then rename the `codegenerator_custom.php` file to `laravel-code-generator.php` if one exists. Alternatively, you can delete both `codegenerator.php` and `codegenerator_custom.php`
Are you interested in supporting this project and making a contribution? Here's how you can get involved:

- Begin by showing your appreciation for this package on GitHub by giving it a **star**.
- Share this project with others to encourage ongoing enhancements and the introduction of new features.
- Report any bugs, provide comments, share ideas, or express your thoughts about this project by creating an issue on GitHub.
- Contributors are encouraged! If you're passionate about this project, consider addressing existing issues by submitting a pull request.
- If possible, consider [sponsoring the project](https://github.com/sponsors/CrestApps).

## Contribution
Do you like this project and want to contribute?
- **HELP WANTED** Version `v2.3` needs to be documented. If you are able to contribute, please read the <a href="https://github.com/CrestApps/laravel-code-generator/blob/v2.3/CHANGELOG.md">change-log</a> in <a href="https://github.com/CrestApps/laravel-code-generator/tree/v2.3">v2.3 branch</a> and document it in the <a href="https://github.com/CrestApps/crestapps-site">CrestApps-site</a> repository. For any help, my email can be found in the `composer.json` file, feel free to send me an email.
- **HELP WANTED** Need to create a new theme for Bootstrap 5 and make it the default. If interested, please submit a PR.
- Please start by ***Staring*** this package on GitHub.
- Sharing this projects with others is your way of saying keep improvements and new awesome feature coming.
- Report any bugs or send us any comments, idea, thought that you may have about this project as an issue on GitHub.

## What did you create with this package?
I'd love to know if your site was generated using this package and list your logo on the documentation site. Please email using my contact info found in `composer.json` file.
Expand Down Expand Up @@ -248,9 +232,7 @@ The following example assumes that we are trying to create a CRUD called <var>As
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and the routes!</var></small></p>
</blockquote>


## What's new?
* <a href="https://crestapps.com/laravel-code-generator/docs/2.3#release-notes">Release Notes</a>
s
* <a href="https://crestapps.com/laravel-code-generator/docs/2.3#upgrade-guide">Upgrade Guide</a>

## License
Expand Down

0 comments on commit bf0c5ed

Please sign in to comment.