From bf0c5edd56914e21fee5a69d8ec0848eaf1db5ce Mon Sep 17 00:00:00 2001 From: Mike Alhayek Date: Sat, 27 Jan 2024 16:42:25 -0800 Subject: [PATCH] update readme --- README.md | 204 +++++++++++++++++++++++++----------------------------- 1 file changed, 93 insertions(+), 111 deletions(-) diff --git a/README.md b/README.md index 4bfe8ca..cfa46db 100644 --- a/README.md +++ b/README.md @@ -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 CrestApps.com - -**Note: ** The available documentation is for versions <= 2.2. The documentation for version 2.3+ is very similar with some exceptions. Please review the Change Log to get a list of the changes. +For full documentation and live demo please visit CrestApps.com ## Features - +- 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 @@ -61,8 +51,6 @@ For full documentation and live demo please visit YouTube.com * https://youtu.be/l21qNcsMAWg @@ -74,84 +62,80 @@ Checkout our channel on 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 change-log in v2.3 branch and document it in the CrestApps-site 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. @@ -248,9 +232,7 @@ The following example assumes that we are trying to create a CRUD called As

Then it will create a model app/Models/AssetCategory, a controller app/Http/Controllers/AssetCategoriesController, all views and the routes!

- -## What's new? -* Release Notes +s * Upgrade Guide ## License