codewithdennis / larament
Laravel和FilamentPHP构建项目的起始模板。
Requires
- php: ^8.2
- filament/filament: ^3.2
- laravel/framework: ^11.9
- laravel/tinker: ^2.9
- timokoerber/laravel-one-time-operations: ^1.4
Requires (Dev)
- barryvdh/laravel-debugbar: ^3.13
- fakerphp/faker: ^1.23
- larastan/larastan: ^2.0
- laravel/pint: ^1.13
- laravel/sail: ^1.26
- mockery/mockery: ^1.6
- nunomaduro/collision: ^8.0
- pestphp/pest: ^3.0.0
- pestphp/pest-plugin-faker: ^3.0.0
- pestphp/pest-plugin-laravel: ^3.0.0
- pestphp/pest-plugin-livewire: ^3.0.0
README
使用Larament启动您的项目并节省时间!这个节省时间的起始套件包括一个已经安装和配置好的带有FilamentPHP的Laravel项目,以及额外功能。
注意
此起始套件包括Laravel 11和FilamentPHP 3,以及一些改进开发体验的包。它不会包含任何臃肿的功能或不必要的包。如果您想添加更多功能,您可以通过安装必要的包来实现。
Filament配置和附加功能
- Filament面板的主色调设置为蓝色。
- 默认启用单页应用(SPA)模式,提供更快更流畅的用户体验。
- 自定义登录页面使用种子数据自动填充电子邮件和密码,消除了在本地测试中手动输入的需要。
- 全局搜索快捷键默认设置为
CTRL + K
或CMD + K
(适用于macOS),以快速访问搜索功能。 - 为
UserResource
提供了一个PEST测试用例,确保所有功能都得到有效测试。 - 全局用户搜索包括电子邮件地址在搜索结果中,以更好地发现用户。
- 在用户资料页和用户资源页上可使用自定义密码生成器操作。
- 自定义资料页利用密码生成功能以简化用户管理。
- 一个可立即使用的自定义主题包括侧边栏分隔符,以更好地组织UI。
- 所有组件标签都是自动可翻译的,因此无需为单个组件添加
->translateLabel()
。 - 包括Archtest进行架构测试。
默认用户(本地)
默认情况下,第一个用户将根据在.env
文件中设置的凭据创建。如果您想在运行种子器后更改默认用户,您可以在.env
文件中更新DEFAULT_USER_EMAIL
和DEFAULT_USER_PASSWORD
,然后再次运行种子器。
DEFAULT_USER_EMAIL="admin@example.com" DEFAULT_USER_PASSWORD="password"
Composer审查
提供了一个名为composer review
的Composer脚本,用于运行以下命令以确保代码库干净且准备就绪以部署。
composer review
该脚本将运行以下命令
./vendor/bin/pest --parallel ./vendor/bin/pint ./vendor/bin/phpstan analyse
助手
我为您设置了一个助手文件,您可以在您的Laravel应用程序中使用它。您可以在app\Helpers.php
中找到它。此文件已准备好供您添加自定义助手函数,Composer将自动将其包含在项目中。
应该是严格的
此模板在AppServiceProvider
的boot方法中具有shouldBeStrict
。此设置将停止懒加载(防止N+1查询问题),静默丢弃属性,并防止访问缺失的属性。这将帮助您及早捕获错误并提高代码质量。
包
timokoerber/laravel-one-time-operations
此包允许您在Laravel应用程序中运行一次性任务。您无需为小型作业创建新的迁移,而是可以使用此包运行一次任务。任何新的单次操作都将放置在database/operations
文件夹中。
此外,将此包添加到您的部署中可能非常有用,因为如果您想在生产环境中修改数据,则无需手动运行种子器。
barryvdh/laravel-debugbar
此包为Laravel应用程序提供开发人员工具栏,用于调试。它包括查询、路由、视图等大量有用信息。
pestphp/pest
PESTPHP是一个专注于简单性的测试框架,精心设计以恢复PHP测试的乐趣。
注意
现在可用的最新版本3是此模板中的默认测试框架!
附加插件
phpstan/phpstan
PHPStan 对整个代码库进行扫描,查找明显和复杂的错误。即使在那些很少执行的if语句中,这些语句肯定没有经过测试。
安装
使用此模板 创建新仓库并将其克隆到本地机器上,然后导航到项目目录以运行必要的命令。
composer install
npm install && npm run build
cp .env.example .env
php artisan key:generate
自 Laravel 11 以来,默认数据库是 SQLite。如果您想使用其他数据库,请在运行迁移之前,使用您的数据库首选项更新 .env
文件。
php artisan migrate --seed
替代安装方法
composer create-project --prefer-dist CodeWithDennis/larament example-app
如果您不想记住 composer 安装语法以供未来项目使用,您可以在终端中为它创建一个别名。
alias larament="composer create-project --prefer-dist CodeWithDennis/larament"
这允许您在终端中简单地使用 larament project-example
。
larament project-example cd project-example/ npm install && npm run build php artisan db:seed php artisan serve
截图
样板
以下文件是“品牌”的一部分,可以删除。
- resources/images/larament.png
- resources/images/user-global-search.jpg