Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chatter-laravel/core
The Laravel single page forum package (Vue + Tailwind CSS + Laravel)
https://github.com/chatter-laravel/core
forum forum-software larave-forum laravel laravel-framework tailwindcss vue vuejs
Last synced: 27 days ago
JSON representation
The Laravel single page forum package (Vue + Tailwind CSS + Laravel)
- Host: GitHub
- URL: https://github.com/chatter-laravel/core
- Owner: Chatter-Laravel
- License: mit
- Created: 2019-11-19T21:04:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-29T08:43:23.000Z (over 2 years ago)
- Last Synced: 2024-10-11T11:03:39.416Z (27 days ago)
- Topics: forum, forum-software, larave-forum, laravel, laravel-framework, tailwindcss, vue, vuejs
- Language: PHP
- Homepage:
- Size: 5.98 MB
- Stars: 159
- Watchers: 15
- Forks: 39
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# Chatter - Laravel Forum Package
This is a Vue + Tailwind CSS + Laravel forum package. Chatter is a single page application to create forums on Laravel applications with ease.
**[See the youtube demo](https://youtu.be/HIaEsMWBV28)**
*This package is inspired on the [thedevdojo/chatter](https://github.com/thedevdojo/chatter) package*
## Installation
If you are planning to install Chatter on an already existing project, please check the ChatterPreset class and check which of the instalations steps you need to run, really dependes on what you got.
Chatter Branch | Chatter Version | Laravel version
--------------- | --------------- | ---------------
5.x|^5.8|^5.8
6.x|^6|^6
7.x|^7|^7
master|dev-master|^8
1. Install [Laravel 8](https://laravel.com/docs/8.x/installation#installing-laravel),
If you are installing Chatter in an existing project skip this step.
2. Include the package in your project and publish the package views, configs, etc:
```bash
$ composer require "chatter-laravel/core:dev-master"
$ php artisan vendor:publish --provider "Chatter\\Core\\ChatterServiceProvider"
$ composer dump-autoload
```
3. Run the `chatter:install` command and follow the instructions:
```bash
$ php artisan chatter:install
```
If you are installing Chatter in an existing project, include the *--plugin* option when you call the install command:
```bash
$ php artisan chatter:install --plugin
```
The installation command will take care of all that you need to install the forum: migrations, js components, tailwind, composer packages, node packages, etc.
> The app must be connected to a running mysql instance to run the migrations, on a development environment [Laravel Sail](https://laravel.com/docs/8.x/sail#installing-sail-into-existing-applications) can be run
4. Add the CanDiscuss and HasApiTokens trait to your [**User model**](https://github.com/laravel/laravel/blob/8.x/app/Models/User.php). If you have Laravel Passport already installed on your project you probably already have the HasApiTokens trait in your *User model*:
```php
[
// Other middleware...
\Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
],
```
**If you are installing Chatter on a fresh Laravel instalation, go straight to step 9**
6. Make sure you have [Tailwind CSS configured with Laravel Mix](https://laravel.com/docs/8.x/mix#tailwindcss)
7. Include the Chatter JS app into your *resources/js/app.js*:
```javascript
require('./chatter/app')
```
8. Populate the categories of your forum. You can create a new seed for your project.
9. Run the Laravel server:
```bash
$ php artisan serve
```
10. **Now, visit http://localhost:8000/forums and you should see your new forum in front of you!**
## Testing
There are some factories that generates some testing information on the database. Just run the seed to execute those factories:
```bash
$ php artisan db:seed --class ChatterTableSeeder
```
## Roadmap
- [x] Check compatiblity with Laravel 8
- [x] React to posts
- [x] Star this repository
- [ ] Pin a discussion
- [ ] Administration/moderation panel (block users, delete posts)
- [ ] Report discussion
- [ ] Edit posts and discussions (with versioning)
- [ ] Users profiles
- [ ] Users rewards
- [ ] Tag other users on discussions and posts
- [ ] Create tests
- [ ] Use Localization (translations)
## Known issues
If you're experiencing issues with your chatter installation, refer to [Known issues](https://github.com/Chatter-Laravel/core/labels/known-issues). If you couldn't solve the issue, please submit a new ticket.
## Customization
### Configuration
When you published the vendor assets you added a new file inside of your `config` folder which is called `config/chatter.php`. This file contains a bunch of configuration you can use to configure your forums
### Vue components
All the view components used by Chatter are published to your project by the preset instalation. You can make all the changes you need for your project on those.
## Screenshots
