README

Laravel框架的简单入门套件。

Hearth是Laravel框架的简单入门套件。它提供了一些开箱即用的功能

一个用户模型，包含登录、注册、电子邮件验证
可选的用户双因素认证支持。
一个组织模型。
一个成员模型，反映用户在组织中的角色。
一个邀请模型，允许用户被邀请加入组织。
一个资源模型，支持创建和访问各种格式的开放教育资源库。
多语言支持，包括本地化路由。
基础视图，可根据需要发布和定制。

安装

Hearth需要PHP >= 8.1和Laravel >= 10。

您可以使用Composer将Hearth安装到新的Laravel项目中

composer require fluid-project/hearth

注意：尝试将Hearth安装到现有Laravel应用中会导致不可预期的行为。

安装Hearth包后，您可以使用hearth:install Artisan命令将Hearth脚手架安装到您的Laravel应用中

php artisan hearth:install

安装Hearth后，您需要安装和构建您的NPM依赖项，运行数据库迁移并链接公共存储

npm install
php artisan migrate
php artisan storage:link

电子邮件

为了测试电子邮件（例如，使用Mailhog和Laravel Sail），您必须更新Laravel应用的.env文件的MAIL_FROM_ADDRESS环境变量，使用正确格式的电子邮件地址。对于本地开发，这可能为noreply@hearth.test（假设您的本地应用可在http://hearth.test访问）。

使用

待办事项。

格式化

要使用Laravel Pint格式化您的代码，可以运行

composer format

应该在每次提交之前做这件事，或者在至少在打开pull请求之前做这件事。

测试

在测试之前，您需要为测试创建一个MySQL或MariaDB数据库，凭据与phpunit.xml.dist中的凭据匹配。然后运行

composer test

如果已安装XDebug，可以通过运行以下命令获取代码覆盖率结果

composer test-coverage

要测试位于stubs目录的代码，您需要将Hearth安装到一个Laravel实例中，并从那里运行测试。

分析/代码风格检查

代码应该通过第5级测试。

composer analyze

要分析位于 stubs 目录中的代码，您需要将Hearth安装到Laravel实例中，并从这里运行分析。phpstan配置作为安装的一部分提供，但需要手动安装Larastan。

变更日志

请参阅变更日志了解最近的变化。

贡献

请参阅贡献指南了解详情。

安全漏洞

请参阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可

BSD 3-Clause许可证。请参阅许可文件了解更多信息。

Hearth中的第三方软件

Hearth基于其他公开的软件，按许可证分类

greatislander / hearth

维护者

详细信息