reytabs/laravel-forum

一个为构建讨论论坛提供坚实基础的开源Laravel包

5.0.x-dev 2024-03-28 07:38 UTC

This package is auto-updated.

Last update: 2024-09-28 09:13:02 UTC


README

Tests phpcs StyleCI Packagist Downloads Packagist License

Laravel Forum Logo

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

版本

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

安装

步骤 1:安装包

使用composer安装包

composer require riari/laravel-forum:~5.0

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

TeamTeaTime\Forum\ForumServiceProvider::class,

步骤 2:发布包文件

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

php artisan vendor:publish

步骤 3:更新您的数据库

运行迁移

php artisan migrate

步骤 4:安装UI预设

从5.6.0版本开始,提供 forum:install 命令来安装UI预设。可用的预设选项包括 bootstrap(Bootstrap 5 UI)和 tailwind(Tailwind CSS UI)。您必须安装其中一个来将相应的视图发布到应用程序中。例如

php artisan forum:install tailwind

其他步骤

配置

一些配置文件已发布到您的应用程序配置目录中,每个文件都以 forum. 为前缀。请参考这些文件,以获取更改论坛行为以及如何将其与您的应用程序代码关键部分集成的各种选项。

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

翻译

Laravel Forum目前支持15种语言:德语、英语、西班牙语、法语、意大利语、荷兰语、罗马尼亚语、俄语、泰语、土耳其语、塞尔维亚语、葡萄牙语(巴西)、瑞典语、中文和印尼语。翻译文件发布到 resources/lang/vendor/forum/{locale}5.0版本中引入了一些新的语言字符串,但尚未翻译;非常欢迎提交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