renzholy/mongood

# Mongood

<img src="./go/assets/logo.png" width="100" height="100" align="right" />

A [MongoDB](https://www.mongodb.com/) GUI with [Fluent Design](https://www.microsoft.com/design/fluent/)

[![License: AGPL 3.0](https://img.shields.io/badge/License-AGPL%203.0-brightgreen.svg)](https://opensource.org/licenses/AGPL-3.0)
[![docker](https://github.com/renzholy/mongood/actions/workflows/docker.yml/badge.svg)](https://github.com/renzholy/mongood/actions/workflows/docker.yml)
![GitHub Actions](https://github.com/renzholy/mongood/workflows/Release/badge.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f7b2974cfea2417a8bd489a9bdbea4a7)](https://app.codacy.com/manual/renzholy/mongood?utm_source=github.com&utm_medium=referral&utm_content=renzholy/mongood&utm_campaign=Badge_Grade_Dashboard)
[![Maintainability](https://api.codeclimate.com/v1/badges/fabee053f887ed00344e/maintainability)](https://codeclimate.com/github/renzholy/mongood/maintainability)

English | [简体中文](./README-zh_CN.md)

## Download ⚡️

- [Run as Client](https://github.com/renzholy/mongood/releases)
- [Run as Server](https://github.com/users/renzholy/packages/container/package/mongood)

## Feature 🔮

- [x] Server or client mode (without Electron, but need Chrome)
- [x] Edit documents using [Monaco Editor](https://microsoft.github.io/monaco-editor/index.html) with intellisense
- [x] Designed with [Microsoft Fluent UI](https://developer.microsoft.com/en-us/fluentui)
- [x] [Mongo Shell](https://docs.mongodb.com/manual/core/shell-types/) compatible data type, eg: `ObjectId()` `ISODate()` `Timestamp()`
- [x] Find documents with index hint, avoiding slow operation
- [x] Fancy profiling exec stats
- [x] Geo preview for 2dsphere index
- [x] Auto generate [JSON Schema Validator](https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/)
- [x] HTTP/2
- [x] Auto **dark** mode

## Screenshot 📷

<table>
  <tr>
    <td align="center"><img src="./screenshot/stats.png">Database status</td>
    <td align="center"><img src="./screenshot/index.png">Find & sort with index</td>
  </tr>
  <tr>
    <td align="center"><img src="./screenshot/geo.png" />Geo preview</td>
    <td align="center"><img src="./screenshot/document.png" />Document mode</td>
  </tr>
  <tr>
    <td align="center"><img src="./screenshot/editor.png" />Edit with Monaco Editor</td>
    <td align="center"><img src="./screenshot/multi-select.png" />Dragable multi-selection</td>
  </tr>
  <tr>
    <td align="center"><img src="./screenshot/export.png" />Documents export</td>
    <td align="center"><img src="./screenshot/indexes.png" />Indexes managment</td>
  </tr>
  <tr>
    <td align="center"><img src="./screenshot/profiling.png" />Analyse profiling</td>
    <td align="center"><img src="./screenshot/schema.png" />Edit JSON Schema</td>
  </tr>
  <tr>
    <td align="center"><img src="./screenshot/dark.png" />Dark mode</td>
  </tr>
</table>

## Development 👨‍💻

### Frontend

```bash
yarn
yarn dev
```

### Backend

```bash
cd go
export MONGO_URIS='[{"name":"name","uri":"mongodb://localhost:27017/"}]'
go run main.go headless.go
```

## Roadmap 🚧

- [ ] Role management
- [ ] Performance moniting
- [ ] VSCode plugin

Feel free to pull request or create a issue !