tiny-rdm/README.md

101 lines
3.5 KiB
Markdown
Raw Normal View History

2023-12-29 15:48:09 +08:00
<h4 align="right"><strong>English</strong> | <a href="https://github.com/tiny-craft/tiny-rdm/blob/main/README_zh.md">
简体中文</a></h4>
2023-08-20 00:53:29 +08:00
<div align="center">
<a href="https://github.com/tiny-craft/tiny-rdm/"><img src="build/appicon.png" width="120"/></a>
</div>
2023-08-20 00:53:29 +08:00
<h1 align="center">Tiny RDM</h1>
<div align="center">
[![License](https://img.shields.io/github/license/tiny-craft/tiny-rdm)](https://github.com/tiny-craft/tiny-rdm/blob/main/LICENSE)
[![GitHub release](https://img.shields.io/github/release/tiny-craft/tiny-rdm)](https://github.com/tiny-craft/tiny-rdm/releases)
2024-01-02 16:12:40 +08:00
![GitHub All Releases](https://img.shields.io/github/downloads/tiny-craft/tiny-rdm/total)
[![GitHub stars](https://img.shields.io/github/stars/tiny-craft/tiny-rdm)](https://github.com/tiny-craft/tiny-rdm/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/tiny-craft/tiny-rdm)](https://github.com/tiny-craft/tiny-rdm/fork)
2023-11-24 10:57:43 +08:00
[![Discord](https://img.shields.io/discord/1170373259133456434?label=Discord&color=5865F2)](https://discord.gg/VTFbBMGjWh)
[![X](https://img.shields.io/badge/Twitter-black?logo=x&logoColor=white)](https://twitter.com/Lykin53448)
2023-12-29 15:48:09 +08:00
<strong>Tiny RDM is a modern lightweight cross-platform Redis desktop manager available for Mac, Windows, and
Linux.</strong>
</div>
2023-06-27 15:53:29 +08:00
2023-11-03 17:55:41 +08:00
<picture>
<source media="(prefers-color-scheme: dark)" srcset="screenshots/dark_en.png">
<source media="(prefers-color-scheme: light)" srcset="screenshots/light_en.png">
<img alt="screenshot" src="screenshots/dark_en.png">
</picture>
2023-06-27 15:53:29 +08:00
## Feature
2023-08-11 11:27:53 +08:00
2023-12-29 15:48:09 +08:00
* Super lightweight, built on Webview2, without embedded browsers (Thanks
to [Wails](https://github.com/wailsapp/wails)).
2024-01-09 00:17:07 +08:00
* Provides visually and user-friendly UI, light and dark themes (Thanks to [Naive UI](https://github.com/tusen-ai/naive-ui)
2023-08-11 11:27:53 +08:00
and [IconPark](https://iconpark.oceanengine.com)).
2023-11-02 15:49:03 +08:00
* Multi-language support ([Need more languages ? Click here to contribute](.github/CONTRIBUTING.md)).
* Better connection management: supports SSH Tunnel/SSL/Sentinel Mode/Cluster Mode.
* Visualize key value operations, CRUD support for Lists, Hashes, Strings, Sets, Sorted Sets, and Streams.
* Support multiple data viewing format and decode/decompression methods.
2023-11-03 10:08:18 +08:00
* Use SCAN for segmented loading, making it easy to list millions of keys.
2024-01-09 00:17:07 +08:00
* Logs list for command operation history.
* Provides command-line mode.
* Provides slow logs list.
2023-11-24 10:57:43 +08:00
* Segmented loading and querying for List/Hash/Set/Sorted Set.
2024-01-09 00:17:07 +08:00
* Provide value decode/decompression for List/Hash/Set/Sorted Set.
* Integrate with Monaco Editor
* Support real-time commands monitoring.
2023-12-29 15:48:09 +08:00
* Support import/export data.
2023-11-02 15:49:03 +08:00
## Roadmap
2023-12-29 15:48:09 +08:00
2023-11-02 15:49:03 +08:00
- [ ] Pub/Sub operations
2023-11-24 10:57:43 +08:00
- [ ] Import/export connection profile
2023-06-27 15:53:29 +08:00
## Installation
Available to download for free from [here](https://github.com/tiny-craft/tiny-rdm/releases).
> If you can't open it after installation on macOS, exec the following command then reopen:
2023-09-06 11:46:34 +08:00
> ``` shell
> sudo xattr -d com.apple.quarantine /Applications/Tiny\ RDM.app
> ```
2023-11-02 15:49:03 +08:00
## Build Guidelines
2023-12-29 15:48:09 +08:00
2023-08-21 18:05:20 +08:00
### Prerequisites
2023-12-29 15:48:09 +08:00
2023-11-02 15:49:03 +08:00
* Go (latest version)
2023-08-21 18:05:20 +08:00
* Node.js >= 16
2023-09-06 11:46:34 +08:00
* NPM >= 9
2023-08-21 18:05:20 +08:00
### Install wails
2023-12-29 15:48:09 +08:00
2023-08-21 18:05:20 +08:00
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
```
### Clone the code
2023-12-29 15:48:09 +08:00
2023-08-21 18:05:20 +08:00
```bash
git clone https://github.com/tiny-craft/tiny-rdm --depth=1
```
### Build frontend
2023-12-29 15:48:09 +08:00
2023-08-21 18:05:20 +08:00
```bash
npm install --prefix ./frontend
```
### Compile and run
2023-12-29 15:48:09 +08:00
2023-08-21 18:05:20 +08:00
```bash
wails dev
```
2024-01-09 00:17:07 +08:00
## About
2023-08-21 18:05:20 +08:00
2024-01-09 00:17:07 +08:00
### Sponsor
2024-01-09 00:17:07 +08:00
If this project helpful for you, feel free to buy me a cup of coffee ☕️.
* Wechat Sponsor
<img src="docs/images/wechat_sponsor.jpg" alt="wechat" width="200" />