realmrhex / filament-modular
支持模块化线材。
Requires
- php: ^8.1
- filament/filament: ^2.0
- nwidart/laravel-modules: >=9
Requires (Dev)
- friendsofphp/php-cs-fixer: dev-master
- orchestra/testbench: dev-develop
- phpunit/phpunit: ^10.1@dev
This package is auto-updated.
Last update: 2024-09-13 17:17:20 UTC
README
Filament Modular
简介
Filament Modular 是一个 Laravel 扩展包,它使得 FilamentPHP 能够在 nwidart/laravel-modules 模块化结构中使用。借助这个扩展包,开发者在构建模块化 Laravel 应用程序时,可以充分利用 Filament 管理面板和仪表盘组件的强大功能。
Filament Modular 通过提供 Laravel Artisan 命令来生成必要的文件和文件夹结构,从而将 Filament 集成到 Laravel 模块中。使用这些命令,开发者可以快速轻松地搭建一个包含完整功能的 Filament 仪表盘的模块化 Laravel 应用程序。
安装
要安装 Filament Modular,只需使用 Composer 将其添加到您的 Laravel 应用程序中。
composer require realmrhex/filament-modular
Laravel 自动发现
Filament Modular 与 Laravel 的包自动发现功能完全兼容,该功能自 Laravel 5.5 以来引入。该功能允许包自动注册到 Laravel,无需在 config/app.php 文件中进行手动注册。
使用包自动发现,可以快速轻松地安装和集成 Filament Modular。当您安装 Filament Modular 时,Laravel 将自动检测该包并注册其服务提供者。
Filament Modular 的服务提供者负责将包的命令、事件监听器和其他组件注册到 Laravel。一旦服务提供者注册成功,您就可以使用包的功能和功能,而无需任何额外的配置。
要利用 Laravel 的包自动发现功能,您必须使用 Laravel 5.5 或更高版本。如果您正在使用 Laravel 的旧版本,您需要在 config/app.php 文件中手动注册 Filament Modular 的服务提供者。
总之,Filament Modular 对 Laravel 包自动发现功能的支持使得开发者可以轻松地将包安装和集成到 Laravel 应用程序中。无需进行任何额外配置,开发者可以在安装后立即开始使用 Filament Modular 的功能和功能。
配置
Filament Modular 附带一个默认配置文件,它定义了 FilamentPHP 与 Laravel 模块集成的默认路径和设置。如果您需要自定义这些设置,可以使用 vendor:publish
Artisan 命令发布配置文件。
php artisan vendor:publish --tag=filament-modular-config
用法
您可以使用所有可用的 Filament make-commands
,使用 module:
前缀以及以下格式。
php artisan module:make-filament-[command] [resource?] [module]
命令
以下为可用命令列表
选项
- -h, --help 显示此帮助信息
- -f, --force 强制覆盖现有文件
示例
在 User
模块中创建一个 Activation
页面
php artisan module:make-filament-page Activation User
在 User
模块中创建一个 User
资源
php artisan module:make-filament-resource UserResource User
结论
使用 Filament Modular,开发者在 Laravel 应用程序中可以同时享受到 FilamentPHP 和 nwidart/laravel-modules 模块化结构的优势。该包提供了一种简单易用的方法来将 Filament 集成到模块化 Laravel 应用程序中,使开发者能够轻松构建强大且灵活的管理面板和仪表盘。
其他详细信息
贡献
我们欢迎并感谢社区的贡献!
如果您想为 Filament Modular 贡献,请按照以下步骤进行
- fork 仓库并创建一个新的分支来存储您的更改。
- 进行您的更改并确保所有测试都通过。
- 提交一个 pull request,并在其中清晰地描述您的更改以及为什么它们是必要的。
请注意,通过参与此项目,您同意遵守行为准则。如果您有任何问题或疑虑,请随时联系我们或在我们的GitHub 仓库上打开一个问题。
我们感谢所有大小贡献,感谢您帮助使 Filament Modular 成为每个人的更好工具!
安全漏洞
如果您在我们的产品中发现安全漏洞,请将电子邮件发送到我们的安全团队 RealMrHex@gmail.com。我们认真对待所有安全漏洞,并将尽快响应报告。我们要求您在我们有机会处理之前不要公开披露问题。
我们感谢您帮助我们使产品更加安全。
致谢
Filament Modular 由 Armin Hooshmand 开发和维护。
我们想感谢以下个人对项目的贡献
- Mohaphez 在测试和错误报告方面的帮助。
我们还要感谢以下项目为我们提供了灵感和指导
如果您想为 Filament Modular 贡献或报告您遇到的问题,请访问我们的 GitHub 仓库。
许可
Filament Modular 是开源软件,根据 MIT 许可证 许可。这意味着您可以自由使用、修改和分发软件,只要您在您的分发中包含原始许可证文件,并为原始作者提供适当的归属。
通过使用 Filament Modular,您同意遵守 MIT 许可证的条件和条款。如果您对许可证有任何疑问或疑虑,请参阅许可证全文以获取更多信息。