weiyu/README.md

Bytedesk

Chat as a Service

Language

• English
• 中文

Introduction

LLM & RAG

• Customer Service based on LLM && RAG

Large model AI assistant

• 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

# 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

Preview

Admin

team	service	ai

Desktop

login	chat	contact	setting

chat-ai	chat-cs	chat-userinfo

Web Chat

custom button color	custom button left	custom button margin	custom iframe margin

custom iframe width	chat full window	chat iframe window	chat embed window

Chat SDK

• iOS-oc
• iOS-swift
• Android
• Flutter
• Vue
• React
• React-native
• UniApp
• Web
• Browser-Extension
• Vscode-plugin

Download Client

• Windows
• Mac
• Linux
• Android
• IOS

Contact

• Email
• Wechat

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方式销售需要获得授权，请勿用于非法用途。