Awesome

Lambda UI

Status:

LambdaUI is a new User Interface for the build tool LambdaCD. It's a single-page application (SPA) based on React/Redux.

See and play with the latest build on Heroku. Just use the the Start Build button and explore all the features.

Features

Quick overview of all recent builds:
Explore details of your Builds:
Have a look at your build step output if it's necessary:

Coming up:

Websockets! Get your build information asap. Instead of polling the results of a build, the server will push new events to the clients.
Support all types of build step results (currently only the output)
Support of browser history within the app.

Do you have more ideas or feedback? Open a feature request!

Usage

As this project is only the User Interface, you'll need running LambdaCD pipeline. The minimum required version of LambdaCD is currently 0.13.3. To use LambdaUI, you'll also need to use the http-kit (we tested it with v2.2.0) webserver to serve the backend of the UI.

Step-by-Step setup

We'll suppose you've setup your pipeline as in the example by LambdaCD

In your project.clj require http-kit and lambdaui:

; ...
:dependencies [ ;...
              [lambdaui "0.1.0-SNAPSHOT"]
              [http-kit "2.2.0"]]
; ...

In your core.clj switch to the new ui:

(ns your.pipeline.core
  (:require [ ; [...]

              ; [lambdacd.ui.ui-server :as ui] -- Replace this by
              [lambdaui.core :as ui]

              ; [ring.server.standalone :as ring-server] -- Replace by
              [org.httpkit.server :as http-kit]
              ; [...]
            ]))

; [...]

(defn -main [args]
  ;[...]

  ; Replace
  ; (ring-server/serve ring-handler {:open-browser? false
  ;                                   :port 8080})
  ; with
  (http-kit/run-server ring-handler { :open-browser? false
                                      :port 8080})
)

That's it! Now start the pipeline as usual and have a look the new UI: http://localhost:8080/lambdaui

Note: The old UI is served as a fallback for your convenience as the default UI at http://localhost:8080.

Also, have a look at the example-pipeline for a complete code example.

Configuration

You can modify your UI by adding an entry to your pipeline config:

; in your -main function:

config {:home-dir home-dir
        :name "some pipeline"   ; Will be used in the UI header.
        :ui-config {            ; Configure the UI here
                    :navbar {
                      :links [ {:url "http://localhost:8080/" :text "Old UI"}]
                    }}

       }

Supported options

:contextPath

This option is necessary, if your UI is not served at the root path of your webserver. The easiest way to set this prefix is by passing the :contextPath option to the ui-for function.

Example:


  ;setup webserver routes with compojure
  (def routes (routes
                (context "/my-pipeline" []
                  (ui/ui-for pipeline :contextPath "/my-pipeline"))))

:navbar

Configure the navigation bar (next to the Header) with custom links (see above). :links is expected to be a sequence.

:link A link for the navigation bar in the header can have three keys:

:url - relative or absolute URL
:text - Text shown
:target (optional, since 0.2.0) - Set the target for the link. Defaults to _blank . Change this to "" if you don't like your links to be opened in a new browser tab.

:showStartBuildButton (experimental) - default: `false`

If set to true, a button is shown in the Header that allows to trigger a new build. This is only necessary if you don't use a pipeline runner with a waiting trigger step. NOTE: This feature is experimental and can disappear in any future version.

:show-version - default: `false`

If set to true serves another endpoint at [prefix]/lambdaui/version and reports the current version of LambdaUI that is used.

:theme - optional

If set to dark, it will override some CSS classes of the LambdaUI to display a dark theme experience.

Contribute

Thanks for your helping hand!

Getting Started

Development

Use the go script to run the necessary build steps:

./go setup -- Run to update npm dependencies. Only required once.
./go serve-ui -- Runs a webserver thats serves the frontend on port 8080. Watches the frontend folder for changes and rebundles them on the fly.
./go serve-backend -- Runs a webserver that serves the backend-for-frontend with dummy data.
./go push -- runs ./go test and git push if tests were successful.
./go jar -- Compiles the project and packs everything into the current jar of lambdaui. Those are located in backend/target/lambdaui-{version}-[qualifier].jar (e.g. backend/target/lambdaui-0.1.0-SNAPSHOT)

Directory Structure

backend contains the clojure project that's being published as a plugin to LambdaCD
frontend contains the JS based UI part of the Plugin.

API for Frontend.

To manipulate the dummy data of the backend, edit dummy_data.clj and restart the backend server with ./go serve-backend. If you're already familiar with Clojure development, you can also start the server in a REPL and edit the dummy data without restarting.

Also see ./go help for further goals. You can also use the NPM targets when inside the resources/ui folder.

Acknowledgements

Many thanks to JetBrains for providing our project with free open source licences for their excellent products to use during the development of LambdaUI!

License

LambdaUI is distributed under the Apache License 2.0.