kue ui
Introduction
Job management client for kue (Version >=0.8.10
)
Screenshots
Installation
$ npm install kue-ui
Setup
Mount with express and kue
var kue = require('kue');
var express = require('express');
var ui = require('kue-ui');
var app = express();
ui.setup({
apiURL: '/api',
baseURL: '/kue',
updateInterval: 5000
});
app.use('/api', kue.app);
app.use('/kue', ui.app);
app.listen(3000);
Note that with the above configuration you can still access the built-in Kue UI at /api/active in the browser.
Standalone app
You can publish the application with any backend by serving the main index file. The application is built with Ember and only has one .jade
file.
var template = require('kue-ui').index
The index file needs to be compiled with jade. You have to define the following locals:
- baseURL: namespace of the application (in previous example:
/kue
), - apiURL: kue's JSON api (in previous example:
/api
) - [optional] updateInterval: Time between each refresh of the app (in previous example: 5000)
Development
An example is provided in example/many.js
. Run it alongside redis (redis-server
)
$ node example/many.js
The app is now accessible on localhost:3000/kue/
.
You can modify the app in lib/client/app
and build it with grunt build
.
Errors
- Forgot to run redis-server
events.js:72
throw er; // Unhandled 'error' event
^
Error: Redis connection to 127.0.0.1:6379 failed - connect ECONNREFUSED
- Stats route not implemented yet on kue. Update kue to
>=0.8.10
GET http://localhost:3000/api/jobs/video%20conversion/inactive/stats 404 (Not Found)
License
kue-ui
is released under the MIT license. See LICENSE.txt for the complete text.
Contributors