tadasei / backend-file-management
A package that provides stubs for managing file associations with models
Requires
- php: ^8.1.0
- illuminate/console: ^9.0|^10.0|^11.0
- illuminate/filesystem: ^9.0|^10.0|^11.0
- illuminate/support: ^9.0|^10.0|^11.0
- illuminate/validation: ^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^8.0
- phpstan/phpstan: ^1.10
README
This package provides stubs for managing files in the backend of a Laravel application. It aims to simplify and streamline common Store, Update and Delete file operations by providing pre-defined structures.
Features
- Quickly generate file management migrations, models, validation rules and handling logic.
- Customize and extend generated code to fit your project's needs.
- Improve development efficiency by eliminating repetitive tasks.
Installation
You can install the package via Composer by running:
composer require tadasei/backend-file-management --dev
Usage
Publishing file management utilities
To publish file management utilities, use the following command:
php artisan file-management:install
Integration with HandleCors Middleware
The package also provides a route file and controller to help integrate Laravel's built-in HandleCors middleware with the storage directory's files. This allows you to manage cross-origin file requests and ensure smooth file handling across different domains.
To publish the HandleCors middleware integration files, add the --with-cors flag to the same command:
php artisan file-management:install --with-cors
The route file and controller can be customized to fit your project's CORS policies. You'll find the generated files in the following locations:
- Route:
routes/resources/file.php - Controller:
app/Http/Controllers/FileController.php
Customization
The generated code serves as a starting point. You can customize and extend it according to your project's requirements. Modify the generated migrations, models, traits and validation rules as needed.
Contributing
Contributions are welcome! If you have suggestions, bug reports, or feature requests, please open an issue on the GitHub repository.
License
This package is open-source software licensed under the MIT license.