README

Chatify Laravel包

一个Laravel包，允许您通过几个简单的步骤将完整的用户消息系统添加到您的新/现有Laravel应用程序中。

要求

PHP >=5.3.2。
Laravel >=5.4
Pusher Api账户。

特性

用户/群组（即将推出）聊天系统。
实时联系人列表更新。
收藏联系人列表（类似故事风格）和添加到收藏夹按钮。
保存消息到保存您的消息在线，就像Telegram消息应用。
搜索功能。
联系人项目最后消息指示器（例如：您：...）。
实时用户活跃状态。
实时打字指示器。
实时已读消息指示器。
实时网络连接状态。
上传附件（照片/文件）。
共享照片、删除对话等。（用户信息在右侧）。
响应式设计，兼容所有设备。
用户设置和聊天定制：用户个人照片、深色模式和聊天颜色。具有简单而精彩的UI设计。

演示

演示应用 - 点击这里。
YouTube上的视频 - 点击这里

安装

YouTube上的视频教程 - 点击这里

或者

按照以下步骤操作

1. 在您的Laravel应用程序中安装此包

快速提示：如果您在新的项目中安装此包，请确保已安装Laravel提供的默认用户身份验证系统。

$ composer require weratad/chatify

2. Pusher Api设置

此包使用Pusher Api，因此您需要

创建账户，并使用您的API凭证修改Laravel应用程序的.env文件。
此包使用了Pusher客户端事件，并且必须在应用程序中启用客户端事件。您可以在Channels仪表板中应用程序的“设置”选项卡中完成此操作。
更多关于Pusher '触发客户端事件'的信息

3. 发布资产

要发布的包资产
重要资产

配置
资产
迁移

以及可选资产

控制器（如果您发布，则需要配置此内容）
视图

要发布资产，请使用以下命令行，更改标记值...这意味着在--tag=后写入chatify- + 如上所述的资产名称。
示例

$ php artisan vendor:publish --tag=chatify-config

注意：发布资产意味着（例如：配置）将包的配置文件创建为Laravel应用程序的config文件夹中的副本，以及其他资产（包的视图、控制器、迁移...）。

4. 迁移

迁移上一步骤中添加的新migrations。

$ php artisan migrate

5. 存储符号链接

在public文件夹中创建到storage文件夹的快捷方式或符号链接。

$ php artisan storage:link

6. 应用程序配置

对于不支持包自动发现的Laravel <=v5.4，请将以下提供者添加到config/app.php providers数组列表中

...
/*
* Package Service Providers...
*/
\Chatify\ChatifyServiceProvider::class,
...

并将以下别名添加到config/app.php aliases

...
/*
* Class Aliases
*/
'Chatify' => Chatify\Facades\ChatifyMessenger::class,
...

安装包后，您可以通过默认路径（路由路径）访问消息传递器，该路径为 /chatify，您可以在下面的配置中提到的配置文件 config/chatify.php 中更改路径名称。

就这样 .. 享受吧 :)

配置

您可以在安装步骤的第 2 步中发布的 config/chatify.php 文件中找到并修改包的默认配置，所有配置都有良好的文档，以便其他开发人员理解。

所有包的文件都有文档说明，以便理解整个代码。

消息传递器名称

此值是用于视图或其他地方的应用程序名称。

...
'name' => env('CHATIFY_NAME', 'Chatify Messenger'),
...

您的应用程序中的消息传递器路径

此值是包的路径，换句话说，它是此包中所有注册路由的前缀。例如（yourapp.domain/chatify）

...
'path' => env('CHATIFY_PATH', 'chatify'),
...

包的 Web 路由中间件

此值是此包中所有注册路由的中间件，默认值为：auth。

...
'middleware' => env('CHATIFY_MIDDLEWARE', 'auth'),
...

Pusher API 凭据

您不需要在此处修改 Pusher 的凭据，因为您已经将凭据添加到 Laravel 应用程序的 .env 文件中。

用户头像

这是用户的头像设置，包括

...
'user_avatar' => [
        'folder' => 'users-avatar',
        ...
    ],
...

这是上传和获取用户头像的默认文件夹名称。

...
'user_avatar' => [
        ...
        'default' => 'avatar.png',
    ],
...

这是数据库中存储用户的默认头像文件名 .. 当您发布 assets 时，头像照片的副本将被复制到您的存储路径中。

默认附件

此数组包含在此包中使用的默认重要值

...
'attachments' => [
        'folder' => 'attachments',
        ...
    ],
...

这是存储中 attachments 的默认文件夹名称，其中所有附件都将存储在此处 .. 并也将用于视图中的附件 URL。

...
'attachments' => [
        ...
        'route' => 'attachments.download',
    ],
...

这是 下载附件 方法的路由名称。

控制器命名空间

如果您在发布 'controllers' 资产后需要更改此包路由控制器的命名空间，则此属性可能会更改，从默认命名空间更改为您应用程序的控制器命名空间。

默认： Chatify\Http\Controllers
如果发布以进行修改，它应该是这样的：App\Http\Controllers\vendor\Chatify

...
'namespace' => env('CHATIFY_ROUTES_NAMESPACE', 'Chatify\Http\Controllers'),

注意

Laravel 8+ 将支持 chatify v2。
Chatify v2 的发布日期可能会因我的工作和一般时间而推迟。
但我保证 (Chatify v2 将很棒)，所以请耐心等待 ❤️

作者

Munaf A. Mahdi

许可协议

MIT

weratad / chatify

维护者

详情