README

A simple Laravel package to add intuitive and simple chat logic to your application

Requirements

Axios
TailwindCSS

Installation

1 - Install the package via composer:

composer require murkrow/simple-chat

2 - Publish the package files:

php artisan vendor:publish --provider="Murkrow\Chat\ChatServiceProvider" --force

3 - Set your pusher credentials in your .env file:

PUSHER_APP_ID=your-pusher-app-id
PUSHER_APP_KEY=your-pusher-key
PUSHER_APP_SECRET=your-pusher-secret
PUSHER_APP_CLUSTER=mt1
BROADCAST_DRIVER=pusher

4 - Include also the following variables in your .env file:

VITE_APP_NAME="${APP_NAME}"
VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

5 - Install the laravel echo and pusher npm packages:

npm install --save-dev laravel-echo pusher-js

6 - Install the laravel pusher composer package:

composer require pusher/pusher-php-server

7 - Add the following code to your resources/js/bootstrap.js file:

import Echo from 'laravel-echo';

import Pusher from 'pusher-js';
window.Pusher = Pusher;

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: import.meta.env.VITE_PUSHER_APP_KEY,
    cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER ?? 'mt1',
    wsHost: import.meta.env.VITE_PUSHER_HOST ? import.meta.env.VITE_PUSHER_HOST : `ws-${import.meta.env.VITE_PUSHER_APP_CLUSTER}.pusher.com`,
    wsPort: import.meta.env.VITE_PUSHER_PORT ?? 80,
    wssPort: import.meta.env.VITE_PUSHER_PORT ?? 443,
    forceTLS: (import.meta.env.VITE_PUSHER_SCHEME ?? 'https') === 'https',
    enabledTransports: ['ws', 'wss'],
});

NOTE:

Make sure to have uncommented App\Providers\BroadcastServiceProvider::class in your config/app.php file

Usage

Add the CanChat trait to your User model:

use Murkrow\Chat\Traits\CanChat;
class User
{
    use CanChat;
}

Customize the trait by overriding the following methods:

class User
{
    use CanChat;

    public function getSecondLineAttribute(): string
    {
        return $this->email;
    }
    public function getAvatarUrlAttribute(): string
    {
        return $this->avatar;
    }
    public function getUsersToStartChatWith() : Builder
    {
        return Utils::getUserClass()::where('id', '!=', $this->id);
    }

    public function canChatWith($targetUserId): bool
    {
        return $targetUserId->role !== 'admin';
    }
}

Events

When a new message is sent, the package will broadcast a NewMessage event to the channel chat.{chat_id}.

murkrow / simple-chat

Maintainers