A web interface for managing PyQueue Server queues, messages, and monitoring.
- 📊 Real-time queue monitoring and statistics
- 📝 Message viewer with search and filtering
- 🎯 Queue management actions
- 🔄 Live updates and auto-refresh
- 🎨 Clean, intuitive UI similar to Kafka-UI
- Node.js 18+ and npm
- PyQueue Server running (backend API)
# Install dependencies
npm installCopy .env.example to .env and configure:
VITE_UI_PORT=3000
VITE_API_HOST=localhost
VITE_API_PORT=8000
VITE_API_URL=http://localhost:8000
# Optional: API key header
VITE_API_KEY=# Start development server
npm run devBy default Vite serves at http://localhost:5173; use npm run dev -- --host --port 3000 if you prefer a custom port.
# Create optimized production build
npm run buildFrom the parent directory containing both pyqueue-server and pyqueue-ui:
# Build and start both services
docker-compose up -d
# View logs
docker-compose logs -f
# Stop services
docker-compose down# Build the image
docker build -t pyqueue-ui .
# Run the container
docker run -p 3000:80 -e VITE_API_URL=http://localhost:8000 pyqueue-uipyqueue-ui/
├── public/ # Static files
├── src/
│ ├── components/ # React components
│ │ ├── QueueList/ # Queue listing view
│ │ ├── QueueDetails/ # Queue detail view
│ │ ├── MessageViewer/ # Message browsing
│ ├── services/ # API clients
│ ├── types/ # TypeScript definitions
│ ├── utils/ # Helper functions
│ └── styles/ # Global styles
├── Dockerfile # Docker build config
├── nginx.conf # Nginx configuration
└── package.json # Dependencies
The UI connects to PyQueue Server API endpoints:
GET /queues- List all queuesGET /queues/{name}- Get queue detailsPOST /queues/{name}/messages- Add messageGET /queues/{name}/messages- Retrieve messagesDELETE /queues/{name}- Delete queueGET /health- Server health check
| Variable | Description | Default |
|---|---|---|
VITE_UI_PORT |
Dev server port override | 3000 |
VITE_API_HOST |
API server hostname | localhost |
VITE_API_PORT |
API server port | 8000 |
VITE_API_URL |
Full API base URL | http://localhost:8000 |
VITE_API_KEY |
Optional API key sent as x-api-key |
(unset) |
- React 18 - UI framework
- TypeScript - Type safety
- React Query - Data fetching and caching
- Axios - HTTP client
- React Router - Navigation
- Nginx - Production web server
| Project | What it is |
|---|---|
| pyqueue-server | Self-hosted queue server with an AWS SQS-style REST API (FastAPI, SQLite or JSON) |
| pyqueue_client | Python client library (pip install pyqueue-client) for a local JSON queue or a remote server |
| pyqueue-ui | Web dashboard to browse queues and messages |
| pynotiq | Worker that delivers queue messages as Telegram notifications |
| keystorebot | Telegram bot that stores key-value pairs in a PyQueue queue |
MIT License - See parent project for details