Skip to content

moudy/agenda-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DEPRECIATED

Try https://github.com/agenda/agendash

Agenda UI

A UI to view Agenda jobs.

Agenda UI Screenshot

Install

npm install --save agenda-ui

Usage

The Agenda UI is middleware you can mount at a path in your express app.

var express = require('express');
var Agenda = require('agenda');
var agendaUI = require('agenda-ui');

var app = express();
var agenda = new Agenda(...)

app.use('/agenda-ui', agendaUI(agenda, {poll: 1000}));

Documentation

agendaUI(agendaInstance, options)

The first argument is the agenda instance. The second is an options object. Currently the only options is poll. This sets the interval the app polls for chnages. It can also be set to false to not poll at all.

Todo and Ideas

  • pagination
  • more human friendly countdown time format
  • a way to view a specific job (i.e. /jobs/:jobId)
  • run/cancel job
  • tests

Developing

This is an Ember app that gets built on prepublish.

To build the app, you will need Bower installed globally (npm install bower -g). After Bower is available, run npm install and then bower install in the app/ directory.

To run the application locally with sample jobs, run npm run dev and ember serve in the /app directory, then visit http://localhost:3022/.

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.