Complete documentation is available on teamteatime.net.
| Laravel version | Package version | PHP version |
|---|---|---|
| 10 | ^5.5 | ^8.1 |
| 9 | ^5.3 | ^8.0 |
| 6 - 8 | ^5.0 | ^7.4 |
| 5 | ^4.0 | ^7.4 |
See the support policy in the Laravel docs for more information about Laravel release versions, their supported PHP versions, and how long they receive bug & security fixes.
Install the package via composer:
composer require riari/laravel-forum:~5.0
Package Discovery should take care of registering the service provider automatically, but if you need to do so manually, add the service provider to your config/app.php:
TeamTeaTime\Forum\ForumServiceProvider::class,Run the vendor:publish command to publish the package config, translations and migrations to your app's directories:
php artisan vendor:publish
Run your migrations:
php artisan migrate
As of 5.6.0, a forum:install command is available for installing UI presets. The available preset options are bootstrap (for a Bootstrap 5 UI) and tailwind (for a Tailwind CSS UI). You must install one of these to publish the corresponding views to your application. For example:
php artisan forum:install tailwind
Several configuration files are published to your application's config directory, each prefixed with forum.. Refer to these for a variety of options for changing the behaviour of the forum and how it integrates with key parts of your application code.
You may need to modify the
forum.integration.user_nameconfig option according to your user model. This specifies which attribute on the user model should be used as a display name in the forum views.
Laravel Forum currently supports 15 languages: German, English, Spanish, French, Italian, Dutch, Romanian, Russian, Thai, Turkish, Serbian, Portuguese (Brazil), Swedish, Chinese, and Indonesian. The translation files are published to resources/lang/vendor/forum/{locale}. Some new language strings have been introduced in 5.0 but not yet translated; PRs to translate these would be greatly appreciated.
If you wish to contribute, an easy way to set up the package for local development is Team-Tea-Time/laravel-studio, which is set up to load a local working copy of this repository (see the readme for usage details).
Bring up the MySQL service:
docker-compose up -d mysqlInstall Composer dependencies:
docker-compose run --rm composer installRun the phpunit container to execute tests:
docker-compose run --rm phpunitThe package tables can be seeded with sample categories, threads, posts, and a user via forum:seed:
docker-compose exec php-fpm php artisan forum:seed