Skip to content
 
 

Repository files navigation

Rocket Redis logo

Rocket Redis

A beautiful desktop GUI for managing Redis databases with ease.

License: MIT Electron 11 React 16 Win | Mac | Linux

🚧 Rocket Redis is under development 🚧 — expect incomplete features and breaking changes.

Features

  • Manage multiple Redis connections (create, edit, test, delete)
  • Browse databases and keys with virtualized lists and debounced search
  • View values for string, hash, list, set and zset keys
  • Persist connections locally with electron-store
  • Custom frameless window, auto-updates via electron-updater, i18n support

Planned / not yet available: key CRUD, TTL management, CLI console, pub/sub, TLS/Cluster/Sentinel/SSH, key pagination with SCAN. See docs/ARCHITECTURE.md for the full status, risks and roadmap.

Layout

UI design: https://www.figma.com/file/YRor24p0TmTxcjl5L86jGb/Rocket-Redis?node-id=1%3A2

Rocket Redis

Prerequisites

  • Node.js (see .nvmrc if present, otherwise any recent LTS works for docs; the app pins Electron 11 / Node 12-era toolchain)
  • Yarn 1.x
  • Optional: Docker to run a local Redis via docker-compose.yml

Quick start

git clone https://github.com/diego3g/rocketredis.git
cd rocketredis
yarn install

Start a local Redis (password redis on 6379):

docker-compose up

Run the app in development mode (React dev server on :4000 + Electron):

yarn dev

Scripts

Script What it does
yarn dev React dev server + Electron (recommended for dev)
yarn build Production build (dist/)
yarn package Build + package installers (portable Win, AppImage Linux, dmg Mac)
yarn lint ESLint over src/ and electron/
yarn tsc TypeScript check (tsc --noEmit)
yarn test Jest (--passWithNoTests, no tests yet)

Tech stack

Electron 11 · React 16 · TypeScript 3.9 · Webpack 4 · styled-components · Recoil · ioredis · Unform + Yup · i18next · electron-store

Details in docs/ARCHITECTURE.md.

Project structure

electron/main.ts        # main process: window, menu, auto-updater
src/App.tsx             # renderer entry: RecoilRoot > ThemeProvider > Screen
src/screen/             # ConnectionsList, KeyList, KeyContent, Header
src/services/           # Redis connection, connection CRUD, key/database loaders
src/atoms/ src/store/   # Recoil state + electron-store persistence
src/components/         # Button, Modal, Input, Toast, EmptyContent
webpack/                # electron + react builds
locales/en/             # i18n strings

Contributing

Contributions are welcome. Fork the repository, create a branch, commit with Conventional Commits (commitlint + husky hooks apply), and open a Pull Request.

License

MIT

About

A beautiful Redis GUI 🔥 (under development)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages