• 🧩 Awesome features
• 🛫 Quick start
• • 📦 Installation
  • 🚀 Run
• 🕋 Architecture diagram
• 🤖 File Directory Description
• 🗓️ community meeting
• 🤼‍ Contributing & Development
• 🚨 License
• 🔮 Thanks to our contributors!

OpenKF

⭐️ OpenKF(Open Knowledge Flow) is an online intelligent customer service system. ⭐️

English • 中文

---

🧩 Awesome features

1. OpenKF is an opensource customer service system based on OpenIM.
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.

📦 Installation

git clone https://https://github.com/OpenIMSDK/OpenKF

🚀 Run

go run main.go

npm run dev

🕋 Architecture diagram

MVC Architecture Design:

🤖 File Directory Description

Catalog standardization design structure:

.
├── 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

We want anyone to get involved in our community, we offer gifts and rewards, and we welcome you to join us every Thursday night.

We take notes of each biweekly meeting in GitHub discussions, and our minutes are written in Google Docs.

🤼‍ Contributing & Development

OpenIMSDK Our goal is to build a top-level open source community. We have a set of standards, in the Community repository.

If you'd like to contribute to this OpenKF repository, please read our contributor documentation.

Before you start, please make sure your changes are in demand. The best for that is to create a new discussion OR Slack Communication, or if you find an issue, report it first.

🚨 License

OpenIMSDK is licensed under the Apache 2.0 license. See LICENSE for the full license text.

🔮 Thanks to our contributors!