Skip to content

oslabs-beta/RPS-View

Repository files navigation

RPS View - Beta version

A web or desktop application to assist in visualization and monitoring of redis pub-sub clients.

Problem

Testing your Redis pub sub clients in development requires multiple redis cli clients. Our tool allows you to create publishers and subscribers and channels in one place and monitor receipt of messages.

App description

This app allows you to track redis pub / sub messages with dummy clients. The app uses

  • Express erver
  • Web sockets on 3030 to send messages to clients
  • Redis IO to connect and subscribe clients
  • Redux/React front end to manage state
  • Redux Thunk middleware for fetch requests, asynchronous actions, and web socket message handling
  • Jest & Supertest for unit tests and integration testing
  • Electron for desktop cabailities

Getting started

To run the application

  • npm install
  • Redis server must be open. Run redis-server if you don't already have a server up for your project.
  • npm run build prepares the webpack bundle and only needs to run once
  • npm run start opens the electron app, using port 3000 for the express server
  • If the electron app is closed at any point, npm run start will reopen it.
  • For development mode (hot reloading), run npm run dev. This will use proxy server 8080 in addition to port 3000.

Important Setup Notes

  • Express - You must be running an Express server on port 3000 for the application to work
  • Redis-server - You must run a redis server - either in your application or on the command line to connect the app. Make sure you connect to the same port that your redis-server is running on. If no server is specified, the application will attempt to create a redis client on port 6379.

Examples

How to contribute

  • We're an open source project, and we're open to new contributions.
  • Add an issue to the github issues before starting a new feature.
  • Make pull requests to staging with issue referenced in the PR.

Contact

Website: [LINK]

Github: https://github.com/oslabs-beta/RPS-View

Team

License

Distributed under the MIT License.