Skip to content
Web interface for Farmhand
Branch: master
Clone or download
Pull request Compare This branch is even with b-ryan:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dev-resources
dev-src
resources/farmhand-ui
src/farmhand/ui
test/farmhand/ui
.gitignore
CHANGELOG.md
LICENSE
README.md
circle.yml
preview.png
project.clj

README.md

Farmhand UI

Farmhand UI is a web interface for Farmhand, with features like:

  • See all of your queues with how many jobs are pending for each of them
  • Drop all pending jobs from your queues
  • View lists of pending, scheduled, completed, and failed jobs
  • Get details on individual jobs, like what function was called with what arguments, what its status is, etc.

Table of Contents generated with DocToc

Installation

Leiningen:

[com.buckryan/farmhand-ui "0.3.1"]

Usage

This library is meant to be use within an existing application running Farmhand. This is not necessary, however, and you are free to run it in a separate process. For now, we will assume you are going to run it inside your existing application.

The farmhand.ui.handler namespace contains one main function for creating a handler that can be used with Jetty, HTTP Kit, etc. Here is what the basic code will look like to create an app:

(ns my.namespace
  (:require [farmhand.core :as farmhand]
            [farmhand.ui.handler :as farmhand-ui]))

;; Start the Farmhand server before creating the handler
(farmhand/start-server)

;; Now create the handler
(def handler (farmhand-ui/app))

;; Now you need to start an HTTP server. See the notes below depending on the
;; server you are using.

Jetty

;; Using the handler created above,
(ring.adapter.jetty/run-jetty handler {})

See more details on run-jetty here.

HTTP Kit

;; Using the handler created above,
(org.httpkit.server/run-server handler)

More documentation can be found here.

Screenshot

Screenshot

You can’t perform that action at this time.