Skip to content

developing-locally.md

Latest commit

 

History

History
54 lines (35 loc) · 2.25 KB

developing-locally.md

File metadata and controls

54 lines (35 loc) · 2.25 KB
Raw

Armada UI

Armada comes with a web UI referred to as Lookout. To understand its components see the Relationships Diagram.

Lookout consists of two components:

  • Lookout API: a Go service that provides an API to the Armada backend
  • Lookout UI: a React application that provides a web interface to the Lookout API

After running mage dev:full and mage ui, you can access the Lookout UI through your browser at http://localhost:8089.

You can also rebuild a production build of the UI by running mage ui in the root of the repo.

Local development

To start developing on the UI locally without having to build:

  1. Ensure you have Docker, Node and Yarn installed for your platform.
  2. Run the following commands:
cd ./internal/lookoutui
yarn
yarn openapi
yarn dev

This starts a live development server on http://localhost:3000.

For this to work, the Lookout API and other Armada components (for example, the Scheduler, Executor and underlying infrastructure services) need to run as well. However, you can use fake data to develop locally without requiring any other component to run.

Using fake data

To use fake data, go to the V2 tab, then specify fakeData= in the query parameters. Alternatively, you can go to http://localhost:3000/v2?fakeData=.

Enabling the debug view

To enable the debug view, add the debug= query parameter to the URL. Alternatively, you can go to http://localhost:3000/v2?debug=.

This displays the TanStack table state as a JSON string, at the bottom of the page. Make sure you scroll down to see it.

Enabling query parameters

To ensure both the fakeData and debug query parameters are enabled at the same time, go to http://localhost:3000/v2?fakeData=&debug=.

To learn more about UI development, see the README for the Lookout UI for more information about UI development.