mirror of
https://gitee.com/270580156/weiyu.git
synced 2026-05-14 11:18:02 +00:00
186 lines
6.8 KiB
Markdown
186 lines
6.8 KiB
Markdown
<!--
|
||
* @Author: jackning 270580156@qq.com
|
||
* @Date: 2024-06-05 09:43:27
|
||
* @LastEditors: jackning 270580156@qq.com
|
||
* @LastEditTime: 2024-09-17 10:03:47
|
||
* @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
|
||
* 联系：270580156@qq.com
|
||
* Copyright (c) 2024 by bytedesk.com, All Rights Reserved.
|
||
-->
|
||
# Bytedesk
|
||
|
||
Chat as a Service
|
||
|
||
## Language
|
||
|
||
- [English](./README.md)
|
||
- [中文](./README.zh.md)
|
||
|
||
## Introduction
|
||
|
||
### LLM & RAG
|
||
|
||
- Customer Service based on LLM && RAG
|
||
- already supported llm: ZhipuAI
|
||
|
||
### AI Copilots
|
||
|
||
- More suitable for team use, one person configuration, for use throughout the company
|
||
|
||
### 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
|
||
|
||
### Social IM
|
||
|
||
- friend chat
|
||
- group chat
|
||
|
||
### Enterprise Instant Messaging/IM
|
||
|
||
- Multi-level organizational structure
|
||
- role management
|
||
- Permission management
|
||
- Chat record management
|
||
|
||
## 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
|
||
# use maven && vscode
|
||
#
|
||
# java --version
|
||
# java 17.0.4 2022-07-19 LTS
|
||
#
|
||
# mvn --version
|
||
# Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)
|
||
# OS name: "mac os x", version: "14.2.1", arch: "aarch64", family: "mac"
|
||
#
|
||
# protobuf is used to generate java code, you may need to install protobuf on your machine
|
||
# protoc --version
|
||
# libprotoc 25.3
|
||
#
|
||
cd bytedesk
|
||
mvn install -Dmaven.test.skip=true
|
||
#
|
||
cd starter
|
||
mvn spring-boot:run
|
||
#
|
||
# local preview:
|
||
developer: http://127.0.0.1:9003/dev
|
||
web: http://127.0.0.1:9003/
|
||
admin: http://127.0.0.1:9003/admin, user/password: admin@email.com/admin
|
||
agent: http://127.0.0.1:9003/agent, user/password: admin@email.com/admin
|
||
chat: http://127.0.0.1:9003/chat?org=df_org_uid&t=0&sid=df_ag_uid&
|
||
api docs: http://127.0.0.1:9003/swagger-ui/index.html
|
||
actuator: http://127.0.0.1:9003/actuator
|
||
h2-console: http://127.0.0.1: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](https://github.com/Bytedesk/bytedesk-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"> |
|
||
|
||
| chat-ai | chat-cs | chat-userinfo |
|
||
| :----------: | :----------: | :----------: |
|
||
| <img src="./images/pc/chat-ai.png" width="250">| <img src="./images/pc/chat-cs.png" width="250"> | <img src="./images/pc/chat-userinfo.png" width="250"> |
|
||
|
||
## [Mobile](https://github.com/Bytedesk/bytedesk-mobile)
|
||
|
||
- [github](https://github.com/Bytedesk/bytedesk-mobile)
|
||
|
||
## [Web Chat](https://github.com/bytedesk/bytedesk-react)
|
||
|
||
| custom button color | custom button left | custom button margin | custom iframe margin |
|
||
| :----------: | :----------: | :----------: | :----------: |
|
||
| <img src="./images/visitor-web/button-color.png" width="250"> | <img src="./images/visitor-web/button-left.png" width="250"> | <img src="./images/visitor-web/button-margin.png" width="250"> | <img src="./images/visitor-web/iframe-margin.png" width="250"> |
|
||
|
||
| custom iframe width | chat full window | chat iframe window | chat embed window |
|
||
| :----------: | :----------: | :----------: | :----------: |
|
||
| <img src="./images/visitor-web/iframe-width.png" width="250"> | <img src="./images/visitor-web/chat-full.png" width="250"> | <img src="./images/visitor-web/chat-iframe.png" width="250"> | <img src="./images/visitor-web/chat-embed.png" width="250"> |
|
||
|
||
## Chat 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) -->
|
||
<!-- - [React-native](https://github.com/bytedesk/bytedesk-react-native) -->
|
||
<!-- - [Vue](https://github.com/bytedesk/bytedesk-vue) -->
|
||
<!-- - [Browser-Extension](https://github.com/Bytedesk/bytedesk-browser-extention) -->
|
||
<!-- - [Vscode-plugin](https://github.com/bytedesk/bytedesk-vscode-plugin) -->
|
||
- [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)
|
||
- [UniApp](https://github.com/bytedesk/bytedesk-uniapp)
|
||
- [Web](https://github.com/bytedesk/bytedesk-web)
|
||
|
||
## 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)
|
||
|
||
## Dev Stack
|
||
|
||
<!-- - [sofaboot](https://github.com/sofastack/sofa-boot/blob/master/README_ZH.md) for im server -->
|
||
- [springboot-3.x for im server](https://github.com/Bytedesk/bytedesk)
|
||
- [python for ai](https://github.com/Bytedesk/bytedesk-ai)
|
||
- [react for web](https://github.com/Bytedesk/bytedesk-react)
|
||
- [flutter for ios&android](https://github.com/Bytedesk/bytedesk-mobile)
|
||
- [electron for windows&mac&linux](https://github.com/Bytedesk/bytedesk-desktop)
|
||
|
||
## Contact
|
||
|
||
- [Email](mailto:270580156@qq.com)
|
||
- [Wechat](./images/wechat.png)
|
||
|
||
## License
|
||
|
||
- support business usage
|
||
<!-- - must not remove trademark && logo info -->
|
||
<!-- - selling, reselling, or hosting Bytedesk IM as a service is a breach of the terms and automatically terminates your rights under the license. -->
|
||
<!-- - 仅支持企业内部员工自用，销售、二次销售或者部署SaaS方式销售需要获得授权，请勿用于非法用途。 -->
|