- OpenKF is an opensource customer service system based on OpenIM.
- Support LLM(Local Knowledgebase) customer service.
- Support multi-channel customer service, and easy to integrate with third-party systems.
- Easy to deploy and secondary development.
Note: You can get started quickly with OpenKF.
git clone https://github.com/OpenIMSDK/OpenKF openkf && export openkf=$(pwd)/openkf && cd $openkf && makeNote: We need to run the backend server first
make buildopen another terminal run the following command
# make dev
cd web
npm run devBe good at using Makefile, it can ensure the quality of your project.
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. ℹ️Note: It's highly recommended that you run
make allbefore committing your code. 🚀
make all
MVC Architecture Design:
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
└── srcWe want anyone to get involved in our community, we offer gifts and rewards, and we welcome you to join us every Thursday night.
Our conference is in the OpenIM Slack 🎯 openkf pipeline, then you can search the openkf pipeline to join
We take notes of each biweekly meeting in GitHub discussions, and our minutes are written in Google Docs.
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.
OpenIMSDK is licensed under the Apache 2.0 license. See LICENSE for the full license text.
The OpenKF logo, including its variations and animated versions, displayed in this repository OpenKF under the assets/logo and assets/logo-gif directories, are protected by copyright laws.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent