https://github.com/acadevmy/redis-websocket-server

REDIS WebSocket Server is a simple NodeJS script used as a bridge to interact with Redis Server via WebSocket.
https://github.com/acadevmy/redis-websocket-server

angular nodejs redis redis-client redis-server

Last synced: 6 months ago
JSON representation

REDIS WebSocket Server is a simple NodeJS script used as a bridge to interact with Redis Server via WebSocket.

• Host: GitHub
• URL: https://github.com/acadevmy/redis-websocket-server
• Owner: acadevmy
• License: apache-2.0
• Created: 2019-11-07T11:34:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-29T19:05:00.000Z (almost 5 years ago)
• Last Synced: 2025-04-15T01:13:00.558Z (12 months ago)
• Topics: angular, nodejs, redis, redis-client, redis-server
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# REDIS WEBSOCKET SERVER

## A simple bridge to use [Redis](https://redis.io/) in a WebSocket way!

_REDIS WebSocket Server_ is a simple NodeJS script used as a bridge to interact with [Redis Server](https://redis.io/) via WebSocket.

### Installing with Docker

Running the environment with Docker:

        

    docker-compose up

Check if _Redis WebSocket Server_ responds at _ws://127.0.0.1:8080_ address.

_Redis WebSocket Server_ uses only these dependencies:  

- WebSocket: https://github.com/websockets/ws   

- ioRedis: https://github.com/luin/ioredis

### Send a command to [Redis Server](https://redis.io/) with _Redis WebSocket Server_

It will be necessary to send a WebSocket request with a payload like this:

    { 

        command: 'SET foo 10', 

        sessionId: this.sessionId, // Client Side generated

        date: Date.now() 

    }

The response will be an object like:

    // Standard Response

    {

        response.command = 'SET foo 10';

        response.output = 'OK';

        response.status = 'ok';

    }

    // Response with error

    {

        response.command = 'unknown';

        response.output = 'Invalid JSON';

        response.status = 'error';

    }

### Contribute

If you wish to contribute please read [CONTRIBUTING.md](https://github.com/acadevmy/redis-websocket-server/blob/master/CONTRIBUTING.md) file.

Thanks for your future contributions!

 

### 🚀 Redis Patterns Console (Angular SPA) 🚀

_Redis WebSocket Server_ is used, for instance, with _Redis Patterns Project_. It is used for communication between [Redis Server](https://redis.io/) and [_Redis Patterns Console_](https://acadevmy.github.io/redis-patterns-console).

With [_Redis Patterns Console_](https://acadevmy.github.io/redis-patterns-console) you can try and go into the deep of [Redis](https://redis.io/) and its patterns with an interactive (and reactive) online console!  

Visit [https://acadevmy.github.io/redis-patterns-console](https://acadevmy.github.io/redis-patterns-console) and enjoy it!

[_Redis Patterns Console_](https://acadevmy.github.io/redis-patterns-console) is an Angular SPA and an open-source project, so you can contribute if you wish.  

Visit our repo on GitHub:  

[https://github.com/acadevmy/redis-patterns-console](https://github.com/acadevmy/redis-patterns-console)

### 📖 Redis Patterns Cookbook 📖

Furthermore, you can visit [_REDIS Patterns Cookbook repository_](https://github.com/acadevmy/redis-patterns-cookbook) and read some of the most common patterns of [Redis](https://redis.io/), the greatest _in memory database_.

 

Maintained with ❤️ by [Acadevmy](https://www.acadevmy.it/intro)