Skip to content

Commit

Permalink
update docs and mvp release
Browse files Browse the repository at this point in the history
Signed-off-by: seven <[email protected]>
  • Loading branch information
Blankll committed Feb 20, 2024
1 parent cecdc3b commit c9320a0
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 5 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,61 @@
# DocKit
<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)
[![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)

tool for local query gui play with NoSQL database
<strong>DocKit is a modern cross-platform NoSQL/NewSQL GUI client. Explore your data any time from your 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

- [ ] ZincSearch support
- [ ] Multi-file support

## Installation

Available to download for free from [here](https://github.com/geek-fun/dockit/releases).

## Build Guidelines

### Prerequisites

* Node.js >= 16
* NPM >= 9

### 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 start
```
## About

### Sponsor
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "DocKit",
"productName": "DocKit",
"private": true,
"version": "0.0.16",
"version": "0.1.0",
"description": "A faster, better and more stable NoSQL desktop tools",
"author": "geekfun <[email protected]>",
"license": "Apache-2.0",
Expand Down
Binary file added public/client-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c9320a0

Please sign in to comment.