README_zh-CN.md

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

英文 • 中文

🧩 特性介绍

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

📺 系统预览

登录注册

系统配置

工作台监控

平台对接

客服会话

🛫 快速开始

注意：你可以快速开始使用 OpenKF。

📦 安装

git clone https://github.com/openimsdk/openkf openkf && export openkf=$(pwd)/openkf && cd $openkf && make

🚀 运行

注意： 我们需要先运行后端服务器

make build

打开另一个终端并运行以下命令

# make dev
cd web
npm run dev

📖 贡献者快速入门

善用 Makefile，它可以确保你的项目的质量。

Usage: make <TARGETS> ...

Targets:
  all                          Build all the necessary targets. 🏗️
  build                        Build binaries by default. 🛠️
  go.build                     Build the binary file of the specified platform. 👨‍💻
  build-multiarch              Build binaries for multiple platforms. 🌍
  tidy                         tidy go.mod 📦
  style                        Code style -> fmt,vet,lint 🎨
  fmt                          Run go fmt against code. ✨
  vet                          Run go vet against code. 🔍
  generate                     Run go generate against code and docs. ✅
  lint                         Run go lint against code. 🔎
  test                         Run unit test ✔️
  cover                        Run unit test with coverage. 🧪
  docker-build                 Build docker image with the manager. 🐳
  docker-push                  Push docker image with the manager. 🔝
  docker-buildx-push           Push docker image with the manager using buildx. 🚢
  copyright-verify             Validate boilerplate headers for assign files. 📄
  copyright-add                Add the boilerplate headers for all files. 📝
  swagger                      Generate swagger document. 📚
  serve-swagger                Serve swagger spec and docs. 🌐
  clean                        Clean all builds. 🧹
  help                         Show this help info. ℹ️

注意： 我们强烈推荐你在提交代码之前运行 make all。🚀

make all

🕋 架构图

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

🗓️ 社区会议

我们欢迎任何人参与我们的社区，我们提供礼品和奖励，每周四晚上欢迎你加入我们。

我们的会议在OpenIM Slack🎯 openkf 管道，然后你可以搜索 openkf 管道加入。

我们在 GitHub 讨论中记录每次双周会议的内容，会议记录我们使用 Google Docs编写。

🤼‍ 贡献与开发

OpenIMSDK 的目标是构建一个顶级的开源社区。我们有一套标准，在社区仓库中。

如果你想为 OpenKF 仓库做出贡献，请阅读我们的贡献者文档。

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

微信群：

如果链接失效了，可以 提一个 issue 说明

🚨 许可证

OpenKF 根据 Apache 2.0 许可证授权。请查看LICENSE获取完整的许可证文本。

此存储库中显示的 OpenKF 标志，包括其变体和动态版本，在 OpenKF下的 assets/logo 和 assets/logo-gif 目录下，受版权法保护。

🔮 感谢我们的贡献者！