openkf

️ OpenKF (Open Knowledge Flow) ist ein intelligentes intelligentes Kundendienstsystem. Euen

Englisch •中文

? Tolle Funktionen

1. OpenKF ist ein OpenSource -Kundendienstsystem, das auf OpenIM basiert.
2. Unterstützung von LLM (Local KnowledgeBase) Kundenservice.
3. Unterstützen Sie den Multi-Channel-Kundendienst und einfach zu integrieren in Systeme von Drittanbietern.
4. Einfach zu bereitstellen und sekundäre Entwicklung.

Systemvorschau

Anmeldeseite

Konfigurationsseite

Dashboard -Seite

Plattformseite

Sitzung Seite

? Schneller Start

Hinweis : Sie können schnell mit OpenKF beginnen.

? Installation

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

Laufen

Hinweis : Wir müssen zuerst den Backend -Server ausführen

make build

Öffnen Sie einen weiteren Terminal. Führen Sie den folgenden Befehl aus

 # make dev
cd web
npm run dev

Mitwirkende machen den Aufstand auf dem neuesten Stand

Seien Sie gut in der Verwendung von Makefile, es kann die Qualität Ihres Projekts gewährleisten.

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. 

Hinweis : Es wird sehr empfohlen, dass Sie make all bevor Sie Ihren Code begehen.

make all

? Architekturdiagramm

MVC -Architektur -Design:

? Beschreibung des Dateiverzeichnisses

Konstruktionsstruktur der Katalog -Standardisierung:

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

Wir möchten, dass sich jemand in unsere Community engagiert, wir Geschenke und Belohnungen anbieten, und wir begrüßen Sie, dass Sie jeden Donnerstagabend zu uns kommen.

Unsere Konferenz befindet sich in der Openim Slack openkf -Pipeline, dann können Sie die OpenKF -Pipeline suchen, um sich anzuschließen

Wir machen uns Notizen über jedes zweiwöchentliche Treffen in Github -Diskussionen, und unsere Protokolle sind in Google Docs geschrieben.

? ‍ beitragen & Entwicklung

OpenImsdk Unser Ziel ist es, eine Open-Source-Community auf höchstem Niveau aufzubauen. Wir haben eine Reihe von Standards im Community -Repository.

Wenn Sie zu diesem OpenKF -Repository beitragen möchten, lesen Sie bitte unsere Mitwirkungsdokumentation.

Bevor Sie beginnen, stellen Sie bitte sicher, dass Ihre Änderungen gefragt sind. Das Beste dafür ist, eine neue Diskussion oder eine neue Kommunikation zu erstellen oder wenn Sie ein Problem finden, melden Sie sie zuerst.

Treten Sie unserer Wechat -Entwicklergruppe bei

Fügen Sie als Freund hinzu und fügen Sie die Notiz openkf hinzu, um eine Einladung zu unserem Gruppenchat "OpenKF" -Enentwickler zu erhalten.

Lizenz

OpenKF ist unter der Apache 2.0 -Lizenz lizenziert. Siehe Lizenz für den vollständigen Lizenztext.

Das OpenKF-Logo, einschließlich seiner Variationen und animierten Versionen, die in diesem Repository OpenKF unter den Verzeichnissen von Assets/Logo und Vermögenswerten/Logo-GIF-Verzeichnissen angezeigt werden, werden durch Urheberrechtsgesetze geschützt.

? Vielen Dank an unsere Mitwirkenden!