vertx-kue - GitLite

KO | EN

gitlite — search

#ai #typescript #golang #go #android #rust #deep-learning #linux #java #kubernetes #awesome-list #pytorch #security #ios

vertx-kue

(★ 146)

Vert.x Blueprint Project - Vert.x Kue, a priority task queue powered by Vert.x

File Explorer

Download Latest Version (.zip)

- docker-compose.yml
- - doc-core.md
  - doc-core.toc.md
  - doc-http.md
  - doc-http.toc.md
  - vertx-kue-features-en.md
- - event_emit_state_machine.png
  - job_state_machine.png
  - kue_diagram.png
  - kue_future_based_methods.png
  - vertx_kue_ui_1.png
- - doc-core.zh-cn.md
  - doc-core.zh-cn.toc.md
  - doc-http.zh-cn.md
  - doc-http.zh-cn.toc.md
  - vertx-kue-features.zh-cn.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- Dockerfile
- README.md
- Dockerfile
.gitignore
.travis.yml
build.gradle
gradlew
gradlew.bat
LICENSE
README.md
README.zh-cn.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/sczyh30/vertx-kue

Downloads the entire project code from GitHub to your computer.

cd vertx-kue

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker-compose up --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Gradle (Java/Kotlin)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

gradle build -x test

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vert.x Kue

[![Build Status](https://travis-ci.org/sczyh30/vertx-kue.svg?branch=master)](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.

![](https://raw.githubusercontent.com/sczyh30/vertx-kue/master/docs/images/vertx_kue_ui_1.png)

### 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

![Diagram - How Vert.x Kue works](https://raw.githubusercontent.com/sczyh30/vertx-kue/master/docs/images/kue_diagram.png)

## Want to improve this blueprint ?

Forks and PRs are definitely welcome !