library laravel-forum

riari/laravel-forum

A Laravel 4/5 package providing a solid foundation for building discussion forums

, _(*1)

, _(*2)

Complete documentation is available on teamteatime.net., _(*3)

Versions

Please note that older package versions not listed above are no longer maintained or supported., _(*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., _(*5)

Installation

Step 1: Install the package

Install the package via composer:, _(*6)

composer require riari/laravel-forum:^6.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 bootstrap/providers.php:, _(*7)

TeamTeaTime\Forum\ForumServiceProvider::class,

Step 2: Publish the package files

Run the vendor:publish command to publish the package config, translations and migrations to your app's directories:, _(*8)

php artisan vendor:publish, _(*9)

Step 3: Update your database

Run your migrations:, _(*10)

php artisan migrate, _(*11)

Step 4: Install a UI preset

A forum:preset-install {name} command is available for installing UI presets. Run forum:preset-list to see a list of available presets. You must install one of these to publish the corresponding views to your application. For example:, _(*12)

php artisan forum:preset-install livewire-tailwind, _(*13)

[!NOTE]
By default, the livewire-tailwind preset is set as the active one in the forum.frontend.preset config value. This preset requires Livewire and a few other dependencies. Refer to UI Presets for details., _(*14)

Additional steps

Configuration

Several configuration files are published to config/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., _(*15)

[!NOTE]
You may need to modify the forum.integration.user_name config 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., _(*16)

Translations

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}., _(*17)

[!NOTE]
Some new language strings have been introduced in version 6 but not yet translated; PRs to translate these would be greatly appreciated., _(*18)

Development

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)., _(*19)

Running tests

Bring up the MySQL service:, _(*20)

docker-compose up -d mysql

Install Composer dependencies:, _(*21)

docker-compose run --rm composer install

Run the phpunit container to execute tests:, _(*22)

docker-compose run --rm phpunit

Seeding

The package tables can be seeded with sample categories, threads, posts, and a user via forum:seed:, _(*23)

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