Skip to content

README.md

Latest commit

 

History

History
52 lines (34 loc) · 2.69 KB

README.md

File metadata and controls

52 lines (34 loc) · 2.69 KB

RedisSMQ Web Server

Pre-release (next) Code Coverage (next)

💡 Note: You are viewing the next branch with upcoming features. For stable releases, check the master branch.

A lightweight server that brings the RedisSMQ management ecosystem to life. It serves the official Web UI and provides the REST API through two flexible modes of operation:

  • Standalone Mode: Run the Web UI and REST API in a single process for an all-in-one setup.
  • Proxy Mode: Serve the Web UI and proxy API requests to a separate redis-smq-rest-api instance for distributed deployments.

Features

  • Dual-Mode Operation: Standalone (UI + API in one process) or Proxy (UI + proxied API).
  • Versatile Execution: Start from the CLI as a standalone server or embed as a library in your Node.js app.
  • Consistent Ecosystem: Works seamlessly with redis-smq, redis-smq-rest-api, and redis-smq-web-ui.

Installation

# Using npm
npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next redis-smq-web-ui@next redis-smq-web-server@next --save

Don't forget to install a Redis client:

npm install @redis/client --save
# or
npm install ioredis --save

Version Compatibility

Always install matching versions of RedisSMQ packages to ensure compatibility. See version compatibility for details.

Documentation

For in-depth guides and API references, see the documentation page.

Related packages

License

RedisSMQ Web Server is released under the MIT License.