Download the PHP package ashique-ar/laravel-crud-generator without Composer

Laravel CRUD Generator

A powerful, configuration-driven CRUD API generator for Laravel applications. Generate complete REST APIs with advanced features like permissions, filtering, sorting, validation, relations management, and custom business logic handlers - all through simple configuration.

✨ Features

• 🚀 Zero-Code CRUD APIs - Generate complete REST APIs through configuration
• � Advanced Relations Management - Dynamic form relations with dependent dropdowns
• �🔐 Permission Integration - Built-in support for Spatie Laravel Permission
• 🎯 Custom Logic Handlers - Extend with custom business logic easily
• 🔍 Advanced Filtering - Search across multiple fields with configurable operators
• 📊 Smart Sorting - Multi-field sorting with default configurations
• ⚡ Bulk Operations - Perform operations on multiple resources at once
• 🗑️ Soft Deletes Support - Full soft delete support with restore capabilities
• ✅ Automatic Validation - Validation rules defined in configuration
• 📚 API Documentation - Auto-generated OpenAPI/Swagger documentation
• 🛠️ Artisan Commands - Powerful commands for scaffolding and management
• 🧪 Fully Tested - Comprehensive test suite included

📋 Requirements

• PHP 8.1+
• Laravel 10.x | 11.x | 12.x
• Spatie Laravel Permission (automatically installed)

📦 Installation

Install the package via Composer:

Run the installation command:

This will:

• Publish the configuration file
• Set up middleware
• Register routes
• Generate initial permissions (optional)

🚀 Quick Start

1. Generate Your First Resource

Use the artisan command to quickly scaffold a new resource:

2. Configure Relations (New!)

Add relations to enable dynamic form management:

3. Example Resource Configuration

Here's a complete example of a resource with relations in config/crud.php:

4. Register API Routes

Add to your routes/api.php or service provider:

Your API endpoints will be available at:

• GET /api/v1/vehicles - List vehicles with pagination, filtering, sorting
• POST /api/v1/vehicles - Create a new vehicle
• GET /api/v1/vehicles/{id} - Get a specific vehicle
• PUT /api/v1/vehicles/{id} - Update a vehicle
• DELETE /api/v1/vehicles/{id} - Delete a vehicle
• GET /api/v1/vehicles/docs - API documentation for vehicles resource

🛠️ Artisan Commands

Resource Management

Options:

• --model= : Specify the model class
• --logic : Generate a custom logic class
• --resource : Generate an API resource class
• --permissions : Generate permissions for this resource
• --force : Overwrite existing files

Relations Management

Options:

• --field= : Field name (e.g., category_id)
• --entity= : Target entity name (e.g., categories)
• --label-field= : Label field (default: name)
• --value-field= : Value field (default: id)
• --display-field= : Display field for tables (default: same as label-field)
• --searchable : Make the relationship searchable
• --nullable : Make the relationship optional (not required)
• --depends-on= : Field this relationship depends on
• --filter-by= : Field to filter by when depends-on is set
• --interactive : Interactive mode

Custom Logic

Permissions

Installation & Setup

🔗 Relationships Configuration

The relationships system allows you to create dynamic forms with dependent dropdowns and complex relationships. This unified approach handles both Laravel Eloquent relationships and form field relationships in one configuration.

Relationship Types

1. Single Select - For foreign key relationships (belongs to)
2. Multiple Select - For many-to-many relationships (coming soon)
3. Dependent Dropdowns - Where one field depends on another

Relationship Configuration Structure

Real-World Examples

Vehicle Management System

Blog Post with Tags

Frontend Integration

Your dynamic frontend can read these configurations and automatically:

1. Generate appropriate form controls based on relationship configuration
2. Fetch options from the appropriate endpoints (/api/crud/{entity})
3. Handle dependent dropdowns by watching parent field changes
4. Support search functionality in dropdowns
5. Validate required/optional fields
6. Display appropriate fields in tables and lists

Example frontend usage:

📊 API Endpoints

All resources automatically get the following endpoints:

Standard CRUD Operations

Additional Endpoints

Query Parameters

Pagination

Search

Sorting

Filtering

Including Relations

⚙️ Configuration Options

Global Configuration

Edit config/crud.php to customize global settings:

Resource Configuration Options

Each resource supports these configuration options:

📖 Available Endpoints

For each configured resource, the following endpoints are automatically generated:

Query Parameters

Pagination

• page - Page number (default: 1)
• per_page - Items per page (default: 15, max: 100)

Search

• search - Search term across configured searchable fields
• search_operator - Search operator: like, exact, starts_with, ends_with (default: like)

Sorting

• sort - Field to sort by
• direction - Sort direction: asc or desc (default: asc)

Filtering

• filter[field] - Filter by specific field value
• filter[field][operator] - Filter with specific operator (=, !=, >, <, >=, <=, like, in, between)

🔧 Advanced Usage

Model Namespacing

The package supports flexible model namespacing to accommodate different project structures:

When using artisan commands, you can specify models in several ways:

Custom Logic Handlers

Create custom business logic for your resources:

This generates:

Then update your configuration:

Adding New Resources

Use the artisan command to quickly add new resources:

This will interactively help you configure:

• Model class and table
• Fillable fields
• Validation rules
• Search and sort configuration
• Permissions
• Relations
• Custom logic handler (optional)

Bulk Operations

Perform operations on multiple resources:

Permissions

The package integrates seamlessly with Spatie Laravel Permission:

API Documentation

Access auto-generated documentation:

Returns OpenAPI 3.0 compatible JSON that can be used with Swagger UI or similar tools.

📝 Configuration

The package uses a comprehensive configuration system in config/crud.php. Here's a complete reference:

Global Configuration

🧪 Testing

The package includes comprehensive tests. Run them using:

Example Test

🔒 Security

Permission Middleware

The package includes built-in permission checking:

This checks for permissions like:

• view-users for GET requests
• create-users for POST requests
• edit-users for PUT/PATCH requests
• delete-users for DELETE requests

Validation

All requests are automatically validated using the rules defined in your configuration:

Use {{id}} in update rules to exclude the current record from unique checks.

Mass Assignment Protection

Only fields defined in fillable arrays are allowed for mass assignment, providing protection against mass assignment vulnerabilities.

📚 Examples

Complete Vehicle Management System

See examples/vehicle-crud-config.php for a complete example of a vehicle management system with:

• Vehicle classes, makes, models
• Dependent dropdowns (model depends on make)
• Complex relationships
• Full CRUD operations

Blog System

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Setup

📄 License

The MIT License (MIT). Please see License File for more information.

🆘 Support

• Documentation: This README and inline documentation
• Issues: GitHub Issues
• Discussions: GitHub Discussions

🗺️ Roadmap

• [ ] GraphQL support
• [ ] Real-time updates with WebSockets
• [ ] Advanced caching strategies
• [ ] Export functionality (CSV, Excel, PDF)
• [ ] Import functionality with validation
• [ ] Audit logging
• [ ] API rate limiting per resource
• [ ] Resource versioning
• [ ] Custom field types and validation rules

Made with ❤️ by Ashique AR ], ],

// Resource definitions
'resources' => [
    // Your resources here...
]

]; bash composer test bash composer test-coverage

## 📝 Configuration

See the [Configuration Guide](docs/configuration.md) for detailed configuration options.

## 🔄 Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## 🤝 Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## 🔒 Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## 📄 License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## 🙏 Credits

- [Your Name](https://github.com/ashique-ar)
- [All Contributors](../../contributors)

## 💡 Support

- [Documentation](https://github.com/ashique-ar/laravel-crud-generator#documentation)
- [Issues](https://github.com/ashique-ar/laravel-crud-generator/issues)
- [Discussions](https://github.com/ashique-ar/laravel-crud-generator/discussions)

---

Made with ❤️ for the Laravel community