Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.15 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.15 KB
Raw

Conduit UI

Conduit UI is the web front-end for Conduit built with Ember.

Architecture

The UI application is a standard Ember application that is simply rooted in the ui directory of the Conduit project. The UI can then be built and embedded into Conduit's binary during a Conduit build.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone git@github.com:ConduitIO/conduit.git the Conduit repository
  • cd conduit
  • make ui-dependencies

Note: Commands in this readme are run from the Conduit project root. Alternatively, you can change into the ui/ directory to directly use Yarn, Ember CLI, or non-prefixed UI Makefile commands.

Running / Development

Before running Conduit UI, you must make sure the Conduit server is running

  • make run

Alternatively, if you'd like to develop the UI against the Conduit server binary

  • make build
  • ./conduit to run the built binary server

After confirming that Conduit server is running locally, you can now run the UI

Running Tests

  • make ui-test

Linting

  • make ui-lint
  • make ui-lint-fix

Building Conduit UI

Conduit UI is built and embedded into the server's binary using Go embed directives. To build the binary with the embedded UI

  • make build-with-ui

This will build the production UI asset bundle, output it to pkg/web/ui/dist, and build the server binary embedded with the bundle.

Further Reading / Useful Links