# dockit

**Repository Path**: geek-fun/dockit

## Basic Information

- **Project Name**: dockit
- **Description**: DocKit - 全新的 ElasticSearch/OpenSearch 桌面客户端
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://dockit.geekfun.club/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-17
- **Last Updated**: 2024-10-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: ElasticSearch, openSearch, elasticsearch-gui, 应用程序, 桌面客户端

## README

<div align="center">
<a href="https://github.com/geek-fun/dockit"><img src="public/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)


<strong>DocKit is a desktop client designed for NoSQL database, support Elasticsearch and OpenSearch across Mac, windows and Linux.</strong>
</div>

## Client
![client UI](public/client-ui.png)

## Feature

* Full-featured editor, Powered by monaco-editor the backbones of vscode, provide familiar editor environment for developers
* Keep your connections, Keep your connections in desktop apps, move the dependencies of dashboard tools
* File persistence, Save your code in your machine as file, never lost
* Multi engines support,Support Elasticsearch, OpenSearch, and more to come
## 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="docs/images/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="docs/images/wechat_ponsor.jpg" alt="wechat sponsor qr code" width="200" />