P3X GitList

dc2f3005

[//]: #@corifeus-header

3288870e

[![NPM](https://nodei.co/npm/p3x-redis-ui.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/p3x-redis-ui/)

dc2f3005

3288870e

[![Build Status](https://travis-ci.org/patrikx3/redis-ui.svg?branch=master)](https://travis-ci.org/patrikx3/redis-ui)

dc2f3005

[![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m780749701-41bcade28c1ea8154eda7cca.svg)](https://uptimerobot.patrikx3.com/)

3288870e

a9628353

# 📡 P3X Redis UI that uses Socket.IO, AngularJs Material and IORedis with statistics, console - terminal, tree, dark mode, internationalization, multiple connections, web and desktop by Electron. v2018.11.22-2

dc2f3005

This is an open-source project. Star this repository, if you like it, or even donate! Thank you so much! :) I run my own server with dynamic IP address, so, it may happen, that the server can not be reachable for about max 15 minutes, due to nature of the dynamic DNS. The server may also be unreachable, when I backup the SSD with Clonzilla (very rarely) or an electrical issue (but this should not happen again). When the server is down, please hang on for 15-30 minutes and the server will be back up. All my domains (patrikx3.com and corifeus.com) could have errors, since I am developing in my free time. However, it is usually stable. **Bugs are evident™ - MATRIX️** ### Node Version Requirement ```

4ca3f155

>=10.13.0

dc2f3005

``` ### Built on Node ```

a9628353

v11.2.0

dc2f3005

``` The ```async``` and ```await``` keywords are required. Install NodeJs: https://nodejs.org/en/download/package-manager/ # Description [//]: #@corifeus-header:end

25bfe903

`p3x-redis-ui` is a new Redis GUI which can serve as a backend server or as a desktop application. Some of the features are coming below.

c0f5b096

👷 **It was created in 20 days in September of 2018.**

fab2a8a0

25bfe903

## Development

8f4f45b8

It creates a package that allows you to compose `p3x-redis-ui-server` and `p3x-redis-ui-material` into one: [Server on GitHub](https://github.com/patrikx3/redis-ui-server) [Client on GitHub](https://github.com/patrikx3/redis-ui-material)

a2e4fc98

c0cca036

By default, only English is created, but given all strings are from a `JS` file, it is very quick to spawn another language eg. German, French, Spanish etc ...

a2e4fc98

8f4f45b8

[English strings, easy to translate](https://github.com/patrikx3/redis-ui-material/blob/master/src/strings/en/strings.js)

79f1d1db

This solution is not using REST at all, but instead uses Socket.IO 🤣, which is weird, but I like it, it is supposed to be more responsive, as there is no big overhead in the HTTP protocol.

a2e4fc98

## The test version https://p3x.redis.patrikx3.com

68836b21

![Screenshot 1](https://cdn.corifeus.com/git/redis-ui/artifacts/preview-images/preview-1.png) ![Screenshot 2](https://cdn.corifeus.com/git/redis-ui/artifacts/preview-images/preview-2.png)

f8cba3cd

baed060a

## Features * Works as a backend

062ea09f

* For now, it only works with HTTPS

a9628353

* Warning: Actually, until Electron NodeJs version is below v10.13.0, we disabled https2 and use https.

baed060a

* Works as a desktop via Electron * I have * Linux * Windows * macOS

062ea09f

* I do not have the money to buy a macOS machine and build an Electron installer, but it would be very easy to do * The error handling took careful (as much I can find errors) * Starts with no settings without config, or setup your own config * Able to create, test, save, delete multiple connections or a readonly connections setup, for shared usage

baed060a

* Able to use the console and interact with Redis

a879b53c

* Online you are able to choose the tree separator, for example :, /, -, space etc... or even empty separator

baed060a

* It is based on Redis-Commander and phpRedisAdmin * You can select the database via console or the drop down, where the checked database is not empty, so you can always know which is filled * Save button to save the db

062ea09f

* There is a performance penalty for this application, given it uses AngularJS `ng-repeat` for the tree component. The best is if your application uses nested keys (something:nested:good), then the tree will be fast, but, for example, Nextcloud uses about 500 keys inline and it can take 5 seconds to generate the tree. * Another solution is that instead of the : separator for your app, you can use the / separator. Then it will be much more responsive, see the settings tree separator

a2e4fc98

* A second solution is to use paging, the default paging is 100 keys

baed060a

* Full statistics pages, can be useful * This is just a New Kind on the Block in the Redis world, so, of course, there are advantages and disadvantages in the other Redis GUIs * Dark - Dracula / light themes

a879b53c

* Search * Client side mode searching in keys - small key set * Server side mode searching in keys - large key set * Search mode * the search keys starts with a string key * the search keys includes a string in the key

baed060a

c07a67e4

# Start up with Electron

bccb3390

Please check out the releases section. ## Releases https://github.com/patrikx3/redis-ui/releases

6fc88e1b

94c74de3

# Start up with a server or via a browser and NodeJs/NPM

6fc88e1b

[Start up with a server readme](artifacts/readme/start-up-server.md)

22717347

# To create your own certificate [To create your own certificate readme](artifacts/readme/create-https-cert.md) # Some description about the config file [Some description about the config file readme](p3xrs.json)

38b36b09

# TODO

594b47a1

[The to do readme](todo.md)

38b36b09

# Change log

94c74de3

[The change log readme](changelog.md)

38b36b09

5fe558e3

dc2f3005

[//]: #@corifeus-footer ---

a9628353

[**P3X-REDIS-UI**](https://pages.corifeus.com/redis-ui) Build v2018.11.22-2

dc2f3005

[![Like Corifeus @ Facebook](https://img.shields.io/badge/LIKE-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software) [![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact) ## P3X Sponsors [IntelliJ - The most intelligent Java IDE](https://www.jetbrains.com) [![JetBrains](https://cdn.corifeus.com/assets/svg/jetbrains-logo.svg)](https://www.jetbrains.com/) [![NoSQLBooster](https://cdn.corifeus.com/assets/png/nosqlbooster-70x70.png)](https://www.nosqlbooster.com/) [The Smartest IDE for MongoDB](https://www.nosqlbooster.com) [//]: #@corifeus-footer:end