⭐️ OpenKF(Open Knowledge Flow) 是一个在线智能客服系统。 ⭐️
🧩 华丽的功能
📺 系统预览
登录页面
配置页面
仪表板页面
平台页面
会话页面
🛫 快速启动
注意:您可以快速启动 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 默认构建二进制文件。 🛠️
go.build 构建指定平台的二进制文件。 👨💻
build-multiarch 构建多个平台的二进制文件。 🌍
tidy 整理 go.mod 文件。 📦
style 代码风格 -> fmt, vet, lint 🎨
fmt 对代码运行 go fmt。 ✨
vet 对代码运行 go vet。 🔍
generate 对代码和文档运行 go generate。 ✅
lint 对代码运行 go lint。 🔎
test 运行单元测试。 ✔️
cover 带覆盖率的单元测试。 🧪
docker-build 使用管理器构建 Docker 镜像。 🐳
docker-push 使用管理器推送 Docker 镜像。 🔝
docker-buildx-push 使用 buildx 管理器推送 Docker 镜像。 🚢
copyright-verify 验证分配文件的样板头文件。 📄
copyright-add 为所有文件添加样板头文件。 📝
swagger 生成 swagger 文档。 📚
serve-swagger 提供 swagger 规范和文档服务。 🌐
clean 清理所有构建。 🧹
help 显示此帮助信息。 ℹ️
注意: 强烈建议您在提交代码之前运行
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 交流,或者如果您发现问题,请先报告。
📱 加入我们的微信开发者群 🛠️
添加好友并附上备注 openkf
以收到加入我们' openkf '开发者群聊的邀请。
🚨 许可证
OpenKF 是在 Apache 2.0 许可下授权的。完整的许可文本请参见 LICENSE。
在此存储库 OpenKF 中显示的 OpenKF 标志,包括其变体和动画版本,受版权法保护,位于 assets/logo 和 assets/logo-gif 目录下。