README

A Laravel package that lets you scaffold complete CRUD (Create, Read, Update, Delete) functionality—with models, migrations, controllers, requests, views, and routes—through a simple web-based UI or programmatically.

Features

Model Generation
Creates an Eloquent model class with fillable properties.
Optional Migration Creation
Generates a timestamped migration file with columns based on your field definitions (string, text, integer, boolean, date, datetime, etc.), including nullable support.
Controller Generation
Builds a resource controller with index, create, store, edit, update, show, and destroy methods.
Form Request Generation
Generates a dedicated FormRequest class for server-side validation of your model's fields.
Blade View Scaffolding
Produces a complete set of Blade templates (index, create, edit, show) under resources/views/{resource}—including dynamic form inputs, tables, and detail pages.
Automatic Route Registration
Appends a Route::resource(...) declaration to routes/web.php, enabling immediate access to your new CRUD endpoints.
Web UI for Configuration
A Bootstrap- and Font Awesome-powered interface where you can:
- Enter Model Name (PascalCase) and Table Name (snake_case, plural).
- Choose whether to generate a migration/seeder.
- Define fields (name, type, validation rules, nullable).
- Dynamically add/remove fields.
- Load quick field templates (Blog Post, Product, User).
Programmatic (CLI) Usage
Inject CrudGeneratorService into your own Artisan commands to generate CRUD definitions from an array of parameters.

Requirements

PHP 8.0+
Laravel 9.x+
Composer
Writable directories:
- app/Models/ (for models)
- database/migrations/ (for migrations)
- app/Http/Controllers/ (for controllers)
- app/Http/Requests/ (for form requests)
- resources/views/ (for views)

Installation

Require the Package

composer require sajidul-islam/laravel-crud-generator

(Optional) Migrate Your Database
```
php artisan migrate
```
Ensure your existing migrations are up-to-date before generating new tables.

Configuration

you can publish the configuration file with:

php artisan vendor:publish --provider="SajidUlIslam\CrudGenerator\CrudGeneratorServiceProvider"

Typical settings include:

Custom namespaces for generated classes.
Default view paths.
List of available field types in the UI dropdown.

If no config/crud-generator.php appears after installation, the package works out-of-the-box with sensible defaults.

Usage

Web UI

Access the Generator
Open your browser and navigate to /crud-generator. If your application uses a custom prefix (e.g., admin), adjust the URL accordingly.
Fill Out the Form
- Model Name (PascalCase) (e.g., Post)
- Table Name (snake_case, plural) (e.g., posts—auto-filled from Model Name)
- Generate Migration (checkbox)
- Generate Seeder (checkbox)
- Fields
  - Field Name (snake_case, no spaces)
  - Type (string, text, integer, boolean, date, datetime, email, password)
  - Validation Rules (Laravel validation syntax, e.g., required|string|max:255)
  - Nullable (checkbox)
- Quick Templates
  - Click a template button (e.g., "Blog Post", "Product", "User") to load predefined fields.
Generate CRUD
Click the "Generate CRUD" button. The package will scaffold files and append routes. A "Results" panel will list every created/modified file and next steps (e.g., run php artisan migrate).

CLI/Artisan Command

The package provides an Artisan command to generate CRUD operations directly from the command line:

Basic Usage

php artisan crud:generate Book

Available Options

{model} - The name of the model (required)
--table= - The name of the table (optional, defaults to plural of model name)
--fields= - Fields in JSON format (optional)
--no-migration - Skip migration generation
--with-seeder - Generate seeder

Examples

1. Interactive Mode (Recommended for beginners)

php artisan crud:generate Post

This will prompt you to enter fields interactively.

2. With JSON Fields

php artisan crud:generate Book --fields='[
    {
        "name": "title",
        "type": "string",
        "validation": "required|string|max:255",
        "nullable": false
    },
    {
        "name": "author",
        "type": "string", 
        "validation": "required|string|max:255",
        "nullable": false
    },
    {
        "name": "published_date",
        "type": "date",
        "validation": "nullable|date",
        "nullable": true
    },
    {
        "name": "summary",
        "type": "text",
        "validation": "nullable|string",
        "nullable": true
    },
    {
        "name": "is_best_seller",
        "type": "boolean",
        "validation": "boolean",
        "nullable": false
    }
]'

3. Custom Table Name

php artisan crud:generate Product --table=products_catalog

4. Skip Migration

php artisan crud:generate Category --no-migration

5. With Seeder

php artisan crud:generate User --with-seeder

Programmatic Usage

You can also call the CrudGeneratorService directly from within your own Artisan commands or controllers:

use SajidUlIslam\CrudGenerator\Services\CrudGeneratorService;

$data = [
    'model_name'     => 'Book',
    'table_name'     => 'books',
    'with_migration' => true,
    'with_seeder'    => false,
    'fields' => [
        [
            'name'       => 'title',
            'type'       => 'string',
            'validation' => 'required|string|max:255',
            'nullable'   => false,
        ],
        // ... more fields
    ],
];

$service = app(CrudGeneratorService::class);
$generated = $service->generateCrud($data);

// $generated is an array of created file paths and the appended route

Troubleshooting

Directory Permissions
Ensure app/Models/, database/migrations/, app/Http/Controllers/, app/Http/Requests/, and resources/views/ are writable (chmod -R 755 <directory>).
Route Duplication
If you regenerate CRUD for the same resource, you may see duplicate Route::resource(...) entries. Manually remove the extra line in routes/web.php.

UI FieldTypes Not Loading
If the UI's <select> elements show empty, verify that your view is receiving a $fieldTypes array. In a controller method serving the UI, you should pass something like:

$fieldTypes = [
    'string'   => 'String',
    'text'     => 'Text',
    'integer'  => 'Integer',
    'boolean'  => 'Boolean',
    'date'     => 'Date',
    'datetime' => 'DateTime',
    'email'    => 'Email',
    'password' => 'Password',
];

return view('vendor.crud-generator.index', compact('fieldTypes'));

Contributing

Fork the Repo
Clone your fork:

git clone https://github.com/your-username/laravel-crud-generator.git
cd laravel-crud-generator

Create a New Branch
```
git checkout -b feature/my-feature
```
Make Changes & Commit
Use clear, concise commit messages.
Push & Open a PR
```
git push origin feature/my-feature
```
Open a pull request against the main branch. Include usage examples or tests if you introduce new functionality.

License

This package is released under the MIT License. Use, modify, and distribute freely.

Version

1.0.1

Repo activity

Acknowledgments

Inspired by Laravel's scaffolders and community-driven CRUD generators.
UI built with Bootstrap 5 and Font Awesome.
Thanks to the Laravel community for ongoing inspiration and best practices.

Happy coding! 🚀

sajidul-islam / laravel-crud-generator

Maintainers

Details