redis-smq-web-ui/README.md

Web UI for RedisSMQ: monitor and manage queues, messages, and consumers.

# RedisSMQ Web UI

![RedisSMQ Web UI - Home](https://raw.githubusercontent.com/weyoss/redis-smq/master/packages/redis-smq-web-ui/docs/screenshots/img01.png)

A Single Page Application for monitoring and managing RedisSMQ. Inspect queues and messages, review consumers, and perform common actions — with an integrated, type-safe OpenAPI client.

- Works seamlessly with the RedisSMQ REST API
- Best served via the RedisSMQ Web Server (serves the static UI and hosts or proxies the API)
- Ships with developer-friendly types and OpenAPI client generation

## Features

- Dashboard for queues, consumers, and message stats
- Queue/message browsers with filters and actions (ack, retry, delete, etc.)
- Supports multiple queue and delivery models
- Exchange types: Direct, Topic, Fanout
- Type-safe OpenAPI client (generated from the REST API schema)

## Requirements

See [RedisSMQ requirements](https://github.com/weyoss/redis-smq/tree/master/README.md).

## Installation

Typically consumed via the [RedisSMQ Web Server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md). To set up everything with pre-release builds:

```bash
npm install redis-smq@latest redis-smq-common@latest redis-smq-rest-api@latest redis-smq-web-ui@latest redis-smq-web-server@latest
# Choose a Redis client:
npm install ioredis
# or
npm install @redis/client
```

## Version Compatibility

Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/docs/version-compatibility.md) for details.

## Documentation

For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui/docs/README.md).

## Related packages

- [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/README.md): Shared components/utilities
- [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API

## License

RedisSMQ Web UI is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).