diff --git a/README.md b/README.md index 0e742b0..7356f99 100644 --- a/README.md +++ b/README.md @@ -30,41 +30,69 @@ ## 🧩 Awesome features - +1. [OpenKF](https://https://github.com/OpenIMSDK/OpenKF) is an opensource customer service system based on [OpenIM](https://https://github.com/OpenIMSDK). +2. Support LLM(Local Knowledgebase) customer service. +3. Support multi-channel customer service, and easy to integrate with third-party systems. +4. Easy to deploy and secondary development. ## 🛫 Quick start > **Note**: You can get started quickly with OpenKF. -1. Generate a [new repository](https://github.com/OpenIMSDK/OpenKF/generate) from the template. -2. Clone the repository locally. -3. Update files, read the README files in each directory. -4. Write your code and tests. - -
- +### 📦 Installation ```bash - +git clone https://https://github.com/OpenIMSDK/OpenKF ``` -
+### 🚀 Run +```bash +``` +## 🕋 Architecture diagram -## 🕋 architecture diagram -```mermaid -``` +![Architecture](assets/images/architecture.png) **MVC Architecture Design:** -```mermaid -``` + +![MVC](assets/images/mvc.png) ## 🤖 File Directory Description Catalog standardization design structure: ```bash +. +├── assets +│ └── images +├── build +├── deploy +├── docs +├── kf_plugins # Local knowledgebase with LLM +│ ├── chat +│ ├── config +│ ├── data +│ ├── logs +│ ├── model +│ └── utils +├── scripts +│ ├── githooks +│ └── LICENSE +├── server # OpenKF backend +│ ├── cmd +│ ├── data +│ ├── docs +│ ├── examples +│ ├── internal +│ ├── logs +│ ├── pkg +│ ├── test +│ └── tools +└── web # OpenKF frontend + ├── public + ├── scripts + └── src ``` ## 🗓️ community meeting @@ -87,6 +115,8 @@ Before you start, please make sure your changes are in demand. The best for that OpenIMSDK is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/OpenKF/tree/main/LICENSE) for the full license text. +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOpenIMSDK%2FOpenIMSDK.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FOpenIMSDK%2FOpenKF?ref=badge_large) + ## 🔮 Thanks to our contributors! diff --git a/README_zh-CN.md b/README_zh-CN.md index e69de29..2ece7e0 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -0,0 +1,122 @@ +

+ + OpenKF
+ +

+

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

+ + +

+A+ +good first + + + + +

+ +

+ +

+ English • + 中文 +

+ +

+ +---- + +## 🧩 特性 + +1. [OpenKF](https://https://github.com/OpenIMSDK/OpenKF) 是基于 [OpenIM](https://https://github.com/OpenIMSDK) 的开源客服系统。 +2. 支持 LLM（本地知识库）客服。 +3. 支持多渠道客服，并易于与第三方系统集成。 +4. 易于部署和二次开发。 + +## 🛫 快速开始 + +> **注意**：您可以通过以下方式快速开始使用 OpenKF。 + +### 📦 安装 + +```bash +git clone https://https://github.com/OpenIMSDK/OpenKF +``` + +### 🚀 运行 + +```bash +``` + +## 🕋 架构图 + +![架构图](assets/images/architecture.png) + +**MVC 架构设计：** + +![MVC](assets/images/mvc.png) + +## 🤖 文件目录说明 + +目录规范化设计结构： + +```bash +. +├── 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 讨论区](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 中记录了每一次[双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting)，我们的会议纪要写在 [Google 文档](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中。 + +## 🤼‍ 贡献与开发 + +OpenIMSDK 的目标是建立一个顶级的开源社区。我们有一套标准，可以在 [Community 仓库](https://github.com/OpenIMSDK/community) 中找到。 + +如果您想对此 OpenKF 仓库进行贡献，请阅读我们的 [贡献者文档](https://github.com/OpenIMSDK/OpenKF/blob/main/CONTRIBUTING.md)。 + +在开始之前，请确保您的更改是需要的。最好的方式是创建一个 [新的讨论](https://github.com/OpenIMSDK/OpenKF/discussions/new/choose) 或使用 [Slack 交流](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)，或者如果您发现了问题，请先进行 [报告](https://github.com/OpenIMSDK/OpenKF/issues/new/choose)。 + +## 🚨 许可证 + +OpenIMSDK 在 Apache 2.0 许可证下发布。完整的许可证文本请参阅 [LICENSE](https://github.com/OpenIMSDK/OpenKF/tree/main/LICENSE)。 + +[![FOSSA 状态](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOpenIMSDK%2FOpenIMSDK.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FOpenIMSDK%2FOpenKF?ref=badge_large) + +## 🔮 感谢我们的贡献者！ + + + + diff --git a/assets/images/architecture.png b/assets/images/architecture.png new file mode 100644 index 0000000..b297c0d Binary files /dev/null and b/assets/images/architecture.png differ diff --git a/assets/images/mvc.png b/assets/images/mvc.png new file mode 100644 index 0000000..a7e0e1e Binary files /dev/null and b/assets/images/mvc.png differ