README

ChatApp 是一个简单灵活的聊天应用程序包，使用 LiveWire 和 Beyond WebSocket 构建。它为 Web 应用程序提供实时聊天功能，使其易于集成和根据项目需求进行定制。

功能

• 实时聊天功能。
• 使用 LiveWire 无缝实现服务器端渲染。
• 使用 Beyond WebSocket 进行高效的 WebSocket 通信。
• 易于集成和定制。

安装

您可以通过 composer 安装此包，如果此命令出错，请将 :dev-main 作为版本添加到末尾

composer require logicrays-tech/chatapp

在安装包后，在 config/app.php 的 Providers 中添加此提供者

Logicrays\ChatApp\ChatAppServiceProviders

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Logicrays\ChatApp\ChatAppServiceProvider" --tag=chatapp

在 package.json 中添加此代码

"dependencies": {
		.......

        "emojionearea": "^3.4.2",
        "laravel-echo": "^1.15.3",
        "pusher-js": "^8.4.0-rc2"

        .......
}

添加此代码后，运行此命令

npm install

然后运行此命令创建模型

php artisan make:model Message

在 Message 模型中替换此代码

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Message extends Model
{
    use HasFactory;
    protected $guarded = [];
}

在 resources/js/bootstrap.js 中添加或替换此代码

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'],
});

更改或添加一些 ENV 变量

BROADCAST_DRIVER=pusher


PUSHER_APP_ID=LOGICID
PUSHER_APP_KEY=LOGICWI828
PUSHER_APP_SECRET=KSK8372U
PUSHER_HOST=127.0.0.1
PUSHER_PORT=6001
PUSHER_SCHEME=http
PUSHER_APP_CLUSTER=mt1

运行此命令以启动 WebSocket

php artian route:clear
php artisan route:clear
php artisan websockets:ser

现在通过输入此 URL http://127.0.0.1:8001/chat-app/ 测试聊天应用程序

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近的变化。

贡献

请参阅 CONTRIBUTING 了解详细信息。

许可证

MIT 许可证（MIT）。请参阅 许可证文件 了解更多信息。