https://github.com/sczyh30/vertx-blueprint-job-queue
Vert.x Blueprint Project - Vert.x Kue, a priority task queue powered by Vert.x
https://github.com/sczyh30/vertx-blueprint-job-queue
job-scheduler redis vertx
Last synced: about 2 months ago
JSON representation
Vert.x Blueprint Project - Vert.x Kue, a priority task queue powered by Vert.x
- Host: GitHub
- URL: https://github.com/sczyh30/vertx-blueprint-job-queue
- Owner: sczyh30
- License: apache-2.0
- Created: 2016-04-26T03:58:37.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-10T20:18:49.000Z (almost 7 years ago)
- Last Synced: 2025-03-11T21:37:01.567Z (about 2 months ago)
- Topics: job-scheduler, redis, vertx
- Language: Java
- Homepage:
- Size: 864 KB
- Stars: 138
- Watchers: 12
- Forks: 34
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- vertx-awesome - Vert.x blueprint - Job Queue - favicon.svg" alt="(stack)" title="Vert.x Stack" height="16px"> - The official Vert.x blueprint showing how to build a distributed job processing application. (Examples)
README
# Vert.x Kue
[](https://travis-ci.org/sczyh30/vertx-kue)
**Vert.x Kue** is a priority task queue developed with Vert.x and backed by **Redis**.
It's a Vert.x implementation version of [Automattic/kue](https://github.com/Automattic/kue).
This blueprint is an introduction to **message-based application development using Vert.x**.
## Detailed Document
Detailed documents and tutorials:
- [English Version](http://sczyh30.github.io/vertx-kue/kue-core/index.html)
- [中文文档](http://sczyh30.github.io/vertx-kue/cn/kue-core/index.html)
## Features
- Job priority
- Delayed jobs
- Process many jobs simultaneously
- Job and queue event
- Optional retries with backoff
- RESTful JSON API
- Rich integrated UI (with the help of Automattic/kue's UI)
- UI progress indication
- Job specific logging
- Future-based asynchronous model
- Polyglot language support
- Powered by Vert.x!
For the detail of the features, please see [Vert.x Kue Features](docs/en/vertx-kue-features-en.md).
## Build/Run
First build the code:
```
gradle build -x test
```
### Run in local
Vert.x Kue requires Redis running:
```
redis-server
```
Then we can run the example:
```
java -jar kue-core/build/libs/vertx-blueprint-kue-core.jar -cluster
java -jar kue-http/build/libs/vertx-blueprint-kue-http.jar -cluster
java -jar kue-example/build/libs/vertx-blueprint-kue-example.jar -cluster
```
Then you can visit `http://localhost:8080` to inspect the queue via Kue UI in the browser.
### Run with Docker Compose
To run Vert.x Kue with Docker Compose:
```
docker-compose up --build
```
Then you can run your applications in the terminal. For example:
```
java -jar kue-example/build/libs/vertx-blueprint-kue-example.jar -cluster
```
# Architecture
## Want to improve this blueprint ?
Forks and PRs are definitely welcome !