riari/laravel-forum

一个提供构建讨论论坛坚实基础的工具包,适用于Laravel


README

Tests phpcs Packagist Downloads Packagist License

Laravel Forum Logo

完整的文档可以在 teamteatime.net 上找到。

版本

请注意,上述未列出的旧版本包不再维护或支持。

有关Laravel版本、它们支持的PHP版本以及它们接收错误和安全修复的时间长度的更多信息,请参阅Laravel文档中的支持策略

安装

步骤 1:安装包

通过composer安装包

composer require riari/laravel-forum:^6.0

包发现应该会自动注册服务提供者,但如果您需要手动操作,请将服务提供者添加到您的 bootstrap/providers.php

TeamTeaTime\Forum\ForumServiceProvider::class,

步骤 2:发布包文件

运行vendor:publish命令以将包的配置、翻译和迁移发布到您的应用目录

php artisan vendor:publish

步骤 3:更新您的数据库

运行迁移

php artisan migrate

步骤 4:安装UI预设

有一个forum:preset-install {name}命令用于安装UI预设。运行forum:preset-list查看可用的预设列表。您必须安装其中一个才能将相应的视图发布到您的应用程序。例如

php artisan forum:preset-install livewire-tailwind

注意

默认情况下,livewire-tailwind预设被设置为forum.frontend.preset配置值中的活动预设。此预设需要Livewire和其他几个依赖项。有关详细信息,请参阅UI预设

其他步骤

配置

一些配置文件已发布到config/forum。请参阅这些文件以了解更改论坛行为及其与您的应用程序代码关键部分的集成的各种选项。

注意

您可能需要根据您的用户模型修改forum.integration.user_name配置选项。这指定了用户模型上应使用哪个属性作为论坛视图中显示的名称。

翻译

Laravel Forum目前支持15种语言:德语、英语、西班牙语、法语、意大利语、荷兰语、罗马尼亚语、俄语、泰语、土耳其语、塞尔维亚语、葡萄牙语(巴西)、瑞典语、中文和印尼语。翻译文件已发布到resources/lang/vendor/forum/{locale}

注意

版本6引入了一些新的语言字符串,但尚未翻译;对于翻译这些字符串的PR将非常感激。

开发

如果您想贡献,设置包以进行本地开发的一个简单方法是Team-Tea-Time/laravel-studio,该工具已设置为加载此存储库的本地工作副本(有关使用详细信息,请参阅readme)。

运行测试

启动MySQL服务

docker-compose up -d mysql

安装Composer依赖项

docker-compose run --rm composer install

运行phpunit容器以执行测试

docker-compose run --rm phpunit

种子

可以通过forum:seed命令在包表中添加样本类别、线程、帖子以及用户。

docker-compose exec php-fpm php artisan forum:seed