README_zh-CN.md

OpenKF

⭐️ OpenKF（开放知识流）是一个在线客服系统。 ⭐️

English • 中文

---

🧩 特性

1. OpenKF 是基于 OpenIM 的开源客服系统。
2. 支持 LLM（本地知识库）客服。
3. 支持多渠道客服，并易于与第三方系统集成。
4. 易于部署和二次开发。

🛫 快速开始

注意：您可以通过以下方式快速开始使用 OpenKF。

📦 安装

git clone https://https:/OpenIMSDK/OpenKF

🚀 运行

🕋 架构图

MVC 架构设计：

🤖 文件目录说明

目录规范化设计结构：

.
├── assets
│   └── images
├── build
├── deploy
├── docs
├── kf_plugins # 带有 LLM 的本地知识库
│   ├── chat
│   ├── config
│   ├── data
│   ├── logs
│   ├── model
│   └── utils
├── scripts
│   ├── githooks
│   └── LICENSE
├── server # OpenKF 后端
│   ├── cmd
│   ├── data
│   ├── docs
│   ├── examples
│   ├── internal
│   ├── logs
│   ├── pkg
│   ├── test
│   └── tools
└── web # OpenKF 前端
    ├── public
    ├── scripts
    └── src

🗓️ 社区会议

我们希望任何人都能参与到我们的社区中来，我们提供礼品和奖励，并欢迎您在每个星期四的晚上加入我们。

我们在 GitHub 讨论区 中记录了每一次双周会议，我们的会议纪要写在 Google 文档 中。

🤼‍ 贡献与开发

OpenIMSDK 的目标是建立一个顶级的开源社区。我们有一套标准，可以在 Community 仓库 中找到。

如果您想对此 OpenKF 仓库进行贡献，请阅读我们的 贡献者文档。

在开始之前，请确保您的更改是需要的。最好的方式是创建一个 新的讨论 或使用 Slack 交流，或者如果您发现了问题，请先进行 报告。

🚨 许可证

OpenIMSDK 在 Apache 2.0 许可证下发布。完整的许可证文本请参阅 LICENSE。

🔮 感谢我们的贡献者！