add dockit (#431)

Signed-off-by: seven <zilisheng1996@gmail.com>
This commit is contained in:
seven 2025-04-09 18:14:39 +08:00 committed by GitHub
parent 9481036195
commit ce2965af0f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 196 additions and 1 deletions

85
docs/DocKit/README.md Normal file
View file

@ -0,0 +1,85 @@
<div align="center">
<a href="https://github.com/geek-fun/dockit"><img src="./assets/dockit.png" width="120"/></a>
</div>
<h1 align="center">DocKit</h1>
<div align="center">
[![Node.js CI](https://github.com/geek-fun/dockit/actions/workflows/node.yml/badge.svg)](https://github.com/geek-fun/dockit/actions/workflows/node.yml)
[![package release](https://github.com/geek-fun/dockit/actions/workflows/release.yml/badge.svg)](https://github.com/geek-fun/dockit/actions/workflows/release.yml)
[![Known Vulnerabilities](https://snyk.io/test/github/geek-fun/dockit/badge.svg)](https://snyk.io/test/github/geek-fun/dockit)
[![codecov](https://codecov.io/gh/geek-fun/dockit/branch/master/graph/badge.svg?token=GqlkEVgMvR)](https://codecov.io/gh/geek-fun/dockit)
[![GitHub version](https://badge.fury.io/gh/geek-fun%2Fdockit.svg)](https://badge.fury.io/gh/geek-fun%2Fdockit)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
</div>
[DocKit](https://dockit.geekfun.club/) is an AI powered desktop GUI client designed for NoSQL database, support Elasticsearch and OpenSearch across Mac, windows and Linux. By integrating with large models like DeepSeek, DocKit can help developers to write complex DSL queries, and provide a better experience for data management and analysis. </td>
## Client
![client UI](./assets/client-ui.png)
## Feature
DocKit offers a range of features to suit your specific needs:
- **User-Friendly Interface**: Navigate through your Elasticsearch/OpenSearch server with ease using DocKit's intuitive interface.
- **Advanced Search Capabilities**: Perform complex searches and analyze your data efficiently.
- **Cross-Platform Support**: Available for Mac, Windows, and Linux, ensuring compatibility with your operating system.
- **Open-Source**: DocKit is an open-source project, allowing for community contributions and continuous improvement.
- **Multiple Server Support**: Connect to multiple Elasticsearch/OpenSearch servers simultaneously, streamlining your workflow.
- **AI-Powered Search**: Utilize AI-powered search capabilities to enhance your data analysis and visualization.
- **Dark Mode Support**: DocKit offers a dark mode to protect your eyes and improve productivity.
- **Multi-Window Support**: DocKit supports multi-window operations, allowing you to view and edit multiple indices and documents simultaneously.
- **Multi-Language Support**: DocKit provides multiple language versions, ensuring ease of use for users worldwide.
- **Cluster Management and Monitoring**: DocKit offers cluster management and monitoring features, helping you easily manage and monitor the health, nodes, shards, and indices of your Elasticsearch clusters.
## Roadmap
- [ ] MongoDB support
- [ ] DynamoDB support
- [ ] TBC
## Installation
Available to download for free from [here](https://github.com/geek-fun/dockit/releases).
## Build Guidelines
### Prerequisites
* Node.js >= 20
* NPM >= 10
### Clone the code
```bash
git clone https://github.com/geek-fun/dockit.git --depth=1
```
### Install dependencies
```bash
npm install
```
### Compile and run
```bash
npm run tauri dev
```
## About
### Wechat Official Account
<img src="./assets/wechat_official.png" alt="wechat official account qr code" width="360" />
### Sponsor
If this project helpful for you, feel free to buy me a cup of coffee ☕️.
* Github Sponsor
[![Sponsor](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub-Sponsors)](https://github.com/sponsors/[geek-fun])
* Wechat Sponsor
<img src="./assets/wechat_ponsor.jpg" alt="wechat sponsor qr code" width="200" />

86
docs/DocKit/README_cn.md Normal file
View file

@ -0,0 +1,86 @@
<div align="center">
<a href="https://github.com/geek-fun/dockit"><img src="./assets/dockit.png" width="120"/></a>
</div>
<h1 align="center">DocKit</h1>
<div align="center">
[![Node.js CI](https://github.com/geek-fun/dockit/actions/workflows/node.yml/badge.svg)](https://github.com/geek-fun/dockit/actions/workflows/node.yml)
[![package release](https://github.com/geek-fun/dockit/actions/workflows/release.yml/badge.svg)](https://github.com/geek-fun/dockit/actions/workflows/release.yml)
[![Known Vulnerabilities](https://snyk.io/test/github/geek-fun/dockit/badge.svg)](https://snyk.io/test/github/geek-fun/dockit)
[![codecov](https://codecov.io/gh/geek-fun/dockit/branch/master/graph/badge.svg?token=GqlkEVgMvR)](https://codecov.io/gh/geek-fun/dockit)
[![GitHub version](https://badge.fury.io/gh/geek-fun%2Fdockit.svg)](https://badge.fury.io/gh/geek-fun%2Fdockit)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
</div>
Here's the translated `README_cn.md` file:
[DocKit](https://dockit.geekfun.club/) 是一个AI驱动的桌面客户端专为NoSQL数据库设计支持Mac、Windows和Linux上的Elasticsearch和OpenSearch。通过集成DeepSeek等大型模型DocKit可以帮助开发者编写复杂的DSL查询并为数据管理和分析提供更好的体验。
## 客户端界面
![客户端界面](./assets/client-ui.png)
## 功能特点
DocKit提供多种功能以满足您的特定需求
- **用户友好界面**通过DocKit直观的界面轻松浏览您的Elasticsearch/OpenSearch服务器。
- **高级搜索功能**:高效执行复杂搜索并分析您的数据。
- **跨平台支持**适用于Mac、Windows和Linux确保与您的操作系统兼容。
- **开源**DocKit是一个开源项目允许社区贡献和持续改进。
- **多服务器支持**同时连接多个Elasticsearch/OpenSearch服务器简化您的工作流程。
- **AI驱动搜索**利用AI驱动的搜索功能增强数据分析和可视化。
- **暗黑模式支持**DocKit提供暗黑模式以保护您的眼睛并提高生产力。
- **多窗口支持**DocKit支持多窗口操作允许您同时查看和编辑多个索引和文档。
- **多语言支持**DocKit提供多种语言版本确保全球用户易于使用。
- **集群管理与监控**DocKit提供集群管理和监控功能帮助您轻松管理和监控Elasticsearch集群的健康状况、节点、分片和索引。
## 路线图
- [ ] MongoDB支持
- [ ] DynamoDB支持
- [ ] 待定
## 安装
可以从[这里](https://github.com/geek-fun/dockit/releases)免费下载。
## 构建指南
### 前提条件
* Node.js >= 20
* NPM >= 10
### 克隆代码
```bash
git clone https://github.com/geek-fun/dockit.git --depth=1
```
### 安装依赖
```bash
npm install
```
### 编译和运行
```bash
npm run tauri dev
```
## 关于
### 微信公众号
<img src="./assets/wechat_official.png" alt="微信公众号二维码" width="360" />
### 赞助
如果这个项目对您有帮助,欢迎给我买杯咖啡 ☕️。
* Github赞助
[![Sponsor](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub-Sponsors)](https://github.com/sponsors/[geek-fun])
* 微信赞助
<img src="./assets/wechat_ponsor.jpg" alt="微信赞助二维码" width="200" />

Binary file not shown.

After

Width:  |  Height:  |  Size: 1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB