-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
25f2a16
commit 9b08b19
Showing
4 changed files
with
327 additions
and
293 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,148 +1,17 @@ | ||
| <!-- | ||
| * @Author: jackning 270580156@qq.com | ||
| * @Date: 2024-01-29 16:43:44 | ||
| * @Date: 2024-06-05 09:43:27 | ||
| * @LastEditors: jackning 270580156@qq.com | ||
| * @LastEditTime: 2024-05-25 12:14:25 | ||
| * @LastEditTime: 2024-06-05 09:43:32 | ||
| * @Description: bytedesk.com https://github.com/Bytedesk/bytedesk | ||
| * Please be aware of the BSL license restrictions before installing Bytedesk IM – | ||
| * selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. | ||
| * 仅支持企业内部员工自用，严禁用于销售、二次销售或者部署SaaS方式销售 | ||
| * Business Source License 1.1: https://github.com/Bytedesk/bytedesk/blob/main/LICENSE | ||
| * contact: 270580156@qq.com | ||
| * Please be aware of the BSL license restrictions before installing Bytedesk IM – | ||
| * selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. | ||
| * 仅支持企业内部员工自用，严禁私自用于销售、二次销售或者部署SaaS方式销售 | ||
| * Business Source License 1.1: https://github.com/Bytedesk/bytedesk/blob/main/LICENSE | ||
| * contact: 270580156@qq.com | ||
| * 联系：270580156@qq.com | ||
| * Copyright (c) 2024 by bytedesk.com, All Rights Reserved. | ||
| * Copyright (c) 2024 by bytedesk.com, All Rights Reserved. | ||
| --> | ||
|
|
||
| # bytedesk | ||
|
|
||
| AI powered customer service & team im | ||
|
|
||
| ## Language | ||
|
|
||
| - [English](./README.md) | ||
| - [中文](./README.zh.md) | ||
|
|
||
| ## Introduction | ||
|
|
||
| ### Enterprise Instant Messaging/IM | ||
|
|
||
| - Multi-level organizational structure | ||
| - role management | ||
| - Permission management | ||
| - Chat record management | ||
|
|
||
| ### Online customer service | ||
|
|
||
| - Support multiple channels, multiple routing strategies, and detailed assessment indicators | ||
| - Seating workbench | ||
| - Work order system | ||
| - Seat management | ||
| - Data dashboard | ||
| - manual knowledge base | ||
| - Skill group management | ||
| - Real-time monitoring | ||
| - Announcements | ||
| - sensitive words | ||
| - CRM | ||
| - Report function, | ||
| - Provide customers with integrated customer service workbench services | ||
|
|
||
| ### Large model AI assistant | ||
|
|
||
| - More suitable for team use, one person configuration, for use throughout the company | ||
|
|
||
| ### Local Area Network File Transfer | ||
|
|
||
| - No need to log in or connect to the internet, use WiFi/hotspots to transfer files across platforms | ||
|
|
||
| <!-- ## Technical Stack | ||
| - [springboot-3.2.0 jdk17/maven/mysql8.0 or postgresql](https://spring.io/projects/spring-boot) for backend | ||
| - [react-18.2.0](https://reactjs.org/) for frontend | ||
| - [react-native-0.73.4](https://reactnative.dev/) for mobile(ios&android) | ||
| - [electron-29.1.1](https://www.electronjs.org/) for desktop(windows&mac&linux) --> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ```bash | ||
| # Notice: this repo is still under ative development, | ||
| # many features are not completed or not stable，the docs are not completed | ||
| git clone https://github.com/Bytedesk/bytedesk.git | ||
| # config file: bytedesk/starter/src/main/resources/application-dev.properties | ||
| cd bytedesk/starter | ||
| mvn spring-boot:run | ||
| # release jar: | ||
| cd bytedesk/starter | ||
| mvn package -Dmaven.test.skip=true | ||
| java -jar bytedesk-starter-0.0.1-SNAPSHOT.jar | ||
| # background run: | ||
| # nohup java -jar bytedesk-starter-0.0.1-SNAPSHOT.jar | ||
| # | ||
| # local preview: | ||
| developer: http://localhost:9003/dev | ||
| web: http://localhost:9003/ | ||
| admin: http://localhost:9003/admin, user/password: admin@email.com/admin | ||
| chat: http://localhost:9003/chat, user/password: admin@email.com/admin | ||
| visitor: http://localhost:9003/v | ||
| api docs: http://localhost:9003/swagger-ui/index.html | ||
| actuator: http://localhost:9003/actuator | ||
| h2-console: http://localhost:9003/h2-console, path: ./h2db/weiyuim, user/password: sa/sa | ||
| ``` | ||
|
|
||
| ## Docs | ||
|
|
||
| - [Docs](https://www.weiyuai.cn/docs/) | ||
|
|
||
| ## Preview | ||
|
|
||
| ### Admin | ||
|
|
||
| | team | service | ai | | ||
| | :----------: | :----------: | :----------: | | ||
| | <img src="./images/admin/team.png" width="250"> | <img src="./images/admin/service.png" width="250"> | <img src="./images/admin/ai.png" width="250"> | | ||
|
|
||
| ## Desktop | ||
|
|
||
| | login | chat | contact | setting | | ||
| | :----------: | :----------: | :----------: | :----------: | | ||
| | <img src="./images/pc/login2.png" width="100"><img src="./images/pc/switch.png" width="100"> | <img src="./images/pc/chat.png" width="250"> | <img src="./images/pc/contact.png" width="250"> | <img src="./images/pc/setting.png" width="250"> | | ||
|
|
||
| ## Customer Service Visitor SDK | ||
|
|
||
| - [iOS-oc](./visitor/oc) | ||
| - [iOS-swift](./visitor/swift) | ||
| - [Android](./visitor/android) | ||
| - [Flutter](./visitor/flutter) | ||
| - [React](./visitor/react) | ||
| - [React-native](./visitor/react-native) | ||
| - [UniApp](./visitor/uniapp) | ||
| - [Web](./visitor/web) | ||
| <!-- - [iOS-oc](https://github.com/Bytedesk/bytedesk-oc) | ||
| - [iOS-swift](https://github.com/Bytedesk/bytedesk-swift) | ||
| - [Android](https://github.com/bytedesk/bytedesk-android) | ||
| - [Flutter](https://github.com/bytedesk/bytedesk-flutter) | ||
| - [React](https://github.com/bytedesk/bytedesk-react) | ||
| - [React-native](https://github.com/bytedesk/bytedesk-react-native) | ||
| - [UniApp](https://github.com/bytedesk/bytedesk-uniapp) | ||
| - [Web](https://github.com/bytedesk/bytedesk-web) | ||
| - [Browser-Extension](https://github.com/bytedesk/bytedesk-browser-extension) | ||
| - [Vscode-plugin](https://github.com/bytedesk/bytedesk-vscode-plugin) --> | ||
|
|
||
| ## Download Client | ||
|
|
||
| - [Windows](https://www.weiyuai.cn/download.html) | ||
| - [Mac](https://www.weiyuai.cn/download.html) | ||
| - [Linux](https://www.weiyuai.cn/download.html) | ||
| - [Android](https://www.weiyuai.cn/download.html) | ||
| - [IOS](https://www.weiyuai.cn/download.html) | ||
|
|
||
| ## Contact | ||
|
|
||
| - [Email](mailto:270580156@qq.com) | ||
| - [Wechat](./images/wechat.png) | ||
|
|
||
| ## License | ||
|
|
||
| - support business usage | ||
| - selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. | ||
| - 仅支持企业内部员工自用，销售、二次销售或者部署SaaS方式销售需要获得授权，请勿用于非法用途。 | ||
| - customer service based on LLM && RAG |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,161 +1,17 @@ | ||
| <!-- | ||
| * @Author: jackning 270580156@qq.com | ||
| * @Date: 2024-01-29 16:43:44 | ||
| * @Date: 2024-06-05 09:44:23 | ||
| * @LastEditors: jackning 270580156@qq.com | ||
| * @LastEditTime: 2024-05-29 11:47:24 | ||
| * @LastEditTime: 2024-06-05 09:44:28 | ||
| * @Description: bytedesk.com https://github.com/Bytedesk/bytedesk | ||
| * Please be aware of the BSL license restrictions before installing Bytedesk IM – | ||
| * selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. | ||
| * 仅支持企业内部员工自用，严禁用于销售、二次销售或者部署SaaS方式销售 | ||
| * Business Source License 1.1: https://github.com/Bytedesk/bytedesk/blob/main/LICENSE | ||
| * contact: 270580156@qq.com | ||
| * Please be aware of the BSL license restrictions before installing Bytedesk IM – | ||
| * selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. | ||
| * 仅支持企业内部员工自用，严禁私自用于销售、二次销售或者部署SaaS方式销售 | ||
| * Business Source License 1.1: https://github.com/Bytedesk/bytedesk/blob/main/LICENSE | ||
| * contact: 270580156@qq.com | ||
| * 联系：270580156@qq.com | ||
| * Copyright (c) 2024 by bytedesk.com, All Rights Reserved. | ||
| * Copyright (c) 2024 by bytedesk.com, All Rights Reserved. | ||
| --> | ||
|
|
||
| # 微语 | ||
|
|
||
| <!-- 基于AI的开源企业IM和在线客服系统。 --> | ||
| - 一款开源聊天软件 | ||
| - 目标：Chat As A Service(CAAS)，聚合多家聊天/客服平台, web/h5/app/小程序/公众号/抖音/telegram...，能对接的尽对接 | ||
| - 重点：对接多家AI大模型平台 | ||
|
|
||
| ## 语言 | ||
|
|
||
| - [English](./README.md) | ||
| - [中文](./README.zh.md) | ||
|
|
||
| ## 介绍 | ||
|
|
||
| ### 社交IM：跟好友聊 | ||
|
|
||
| - 好友、 | ||
| - 群组、 | ||
|
|
||
| ### 企业IM：跟同事聊 | ||
|
|
||
| - 多层组织架构、 | ||
| - 角色管理 | ||
| - 权限管理 | ||
| - 聊天记录管理 | ||
|
|
||
| ### 在线客服：跟客户聊 | ||
|
|
||
| - 支持多渠道、多种路由策略、详细考核指标 | ||
| - 坐席工作台、 | ||
| - 工单系统、 | ||
| - 坐席管理、 | ||
| - 数据看板、 | ||
| - 人工知识库、 | ||
| - 技能组管理、 | ||
| - 实时监控、 | ||
| - 公告、 | ||
| - 敏感词、 | ||
| - CRM、 | ||
| - 报表功能， | ||
| - 为客户提供一体化客服工作台服务 | ||
|
|
||
| ### 智能客服：跟AI聊 | ||
|
|
||
| ### 大模型AI助手：跟AI聊 | ||
|
|
||
| - 更适合团队使用，一人配置，全公司使用 | ||
|
|
||
| ### 局域网文件传输 | ||
|
|
||
| - 无需登录，无需连接外网，利用WiFi/热点跨平台传文件 | ||
|
|
||
| ## 快速开始 | ||
|
|
||
| ```bash | ||
| # 注意: 此开源版本处于早期阶段，许多功能尚未完善或测试未完成，文档尚待完善，请勿在生产环境使用 | ||
| git clone https://github.com/Bytedesk/bytedesk.git | ||
| # 配置文件: bytedesk/starter/src/main/resources/application-dev.properties | ||
| cd bytedesk/starter | ||
| mvn spring-boot:run | ||
| # 打包jar并运行: | ||
| cd bytedesk/starter | ||
| mvn package -Dmaven.test.skip=true | ||
| java -jar bytedesk-starter-0.0.1-SNAPSHOT.jar | ||
| # 后台运行 | ||
| nohup java -jar bytedesk-starter-0.0.1-SNAPSHOT.jar | ||
| # | ||
| # 本地预览 | ||
| 开发者入口: http://localhost:9003/dev | ||
| web: http://localhost:9003/ | ||
| 管理后台: http://localhost:9003/admin, 用户名: admin@email.com, 密码: admin | ||
| WebIM/客服端: http://localhost:9003/chat, 用户名: admin@email.com, 密码: admin | ||
| 访客对话窗口: http://localhost:9003/v | ||
| api文档: http://localhost:9003/swagger-ui/index.html | ||
| actuator: http://localhost:9003/actuator | ||
| h2数据库: http://localhost:9003/h2-console, 路径: ./h2db/weiyuim, 用户名: sa, 密码: sa | ||
| ``` | ||
|
|
||
| ## 文档 | ||
|
|
||
| - [文档](https://www.weiyuai.cn/docs/) | ||
|
|
||
| ## 预览 | ||
|
|
||
| ### 管理后台 | ||
|
|
||
| | 组织 | 客服 | ai | | ||
| | :----------: | :----------: | :----------: | | ||
| | <img src="./images/admin/team.png" width="250"> | <img src="./images/admin/service.png" width="250"> | <img src="./images/admin/ai.png" width="250"> | | ||
|
|
||
| ## 桌面客户端 | ||
|
|
||
| | 登录 | 对话 | 通讯录 | 设置 | | ||
| | :----------: | :----------: | :----------: | :----------: | | ||
| | <img src="./images/pc/login2.png" width="100"><img src="./images/pc/switch.png" width="100"> | <img src="./images/pc/chat.png" width="250"> | <img src="./images/pc/contact.png" width="250"> | <img src="./images/pc/setting.png" width="250"> | | ||
|
|
||
| ## 在线客服-访客端SDK | ||
|
|
||
| - [iOS-oc](./visitor/oc) | ||
| - [iOS-swift](./visitor/swift) | ||
| - [Android](./visitor/android) | ||
| - [Flutter](./visitor/flutter) | ||
| - [React](./visitor/react) | ||
| - [React-native](./visitor/react-native) | ||
| - [UniApp](./visitor/uniapp) | ||
| - [Web](./visitor/web) | ||
| <!-- - [iOS-oc](https://github.com/Bytedesk/bytedesk-oc) | ||
| - [iOS-swift](https://github.com/Bytedesk/bytedesk-swift) | ||
| - [Android](https://github.com/bytedesk/bytedesk-android) | ||
| - [Flutter](https://github.com/bytedesk/bytedesk-flutter) | ||
| - [React](https://github.com/bytedesk/bytedesk-react) | ||
| - [React-native](https://github.com/bytedesk/bytedesk-react-native) | ||
| - [UniApp](https://github.com/bytedesk/bytedesk-uniapp) | ||
| - [Web](https://github.com/bytedesk/bytedesk-web) | ||
| - [Browser-Extension](https://github.com/bytedesk/bytedesk-browser-extension) | ||
| - [Vscode-plugin](https://github.com/bytedesk/bytedesk-vscode-plugin) --> | ||
|
|
||
| ## 客户端&客服端 | ||
|
|
||
| - [Windows](https://www.weiyuai.cn/download.html) | ||
| - [Mac](https://www.weiyuai.cn/download.html) | ||
| - [Linux](https://www.weiyuai.cn/download.html) | ||
| - [Android](https://www.weiyuai.cn/download.html) | ||
| - [IOS](https://www.weiyuai.cn/download.html) | ||
|
|
||
| ## 技术栈 - 基于金融级云原生架构 | ||
|
|
||
| <!-- - [springboot-3.2.0 jdk17/maven/h2/mysql8.0/postgresql/oracle(jpa支持的所有数据库)](https://spring.io/projects/spring-boot) for 后端 --> | ||
| - [sofaboot-4.2.0 jdk17/maven/h2/mysql8.0/postgresql/oracle(jpa支持的所有数据库)](https://github.com/sofastack/sofa-boot/blob/master/README_ZH.md) for 后端 | ||
| - [python-3.10](https://docs.python.org/zh-cn/3/) for AI助手 | ||
| - [react-18.2.0](https://reactjs.org/) for web前端 | ||
| - [react-native-0.73.4](https://reactnative.dev/) for 移动客户端(ios&android) | ||
| - [electron-29.1.1](https://www.electronjs.org/) for 桌面客户端(windows&mac&linux) | ||
|
|
||
| <!-- 有兴趣的同学，特别是独立开发者，欢迎加入，共同开发，利润共享。 --> | ||
|
|
||
| ## 联系 | ||
|
|
||
| - [Email](mailto:270580156@qq.com) | ||
| - [微信](./images/wechat.png) | ||
|
|
||
| ## [声明](https://www.weiyuai.cn/) | ||
|
|
||
| - 支持商用 | ||
| - 仅支持企业内部员工自用，销售、二次销售或者部署SaaS方式销售需要获得授权 | ||
| - 请勿用于非法用途 | ||
| - 基于 LLM 和 RAG 的智能客服 |
Oops, something went wrong.