Files
weiyu/README.md
jack ning bc79fdd2ee update
2024-06-12 12:07:31 +08:00

146 lines
4.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!--
* @Author: jackning 270580156@qq.com
* @Date: 2024-06-05 09:43:27
* @LastEditors: jackning 270580156@qq.com
* @LastEditTime: 2024-06-12 12:07:25
* @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
### 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
### Customer service assistant
- Customer Service based on LLM && RAG
### Large model AI assistant
- More suitable for team use, one person configuration, for use throughout the company
## Getting Started
```bash
# Notice: this repo is still under ative development,
# many features are not completed or not stablethe docs are not completed
git clone https://github.com/Bytedesk/bytedesk.git
# config file: bytedesk/starter/src/main/resources/application-dev.properties
#
cd bytedesk
mvn install -Dmaven.test.skip=true
#
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
agent: http://localhost:9003/agent, user/password: admin@email.com/admin
chat: http://localhost:9003/chat?t=0&sid=default_agent_uid&
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
- 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方式销售需要获得授权请勿用于非法用途。