Boundary UI Monorepo

This monorepo contains multiple projects, including UIs and addons, used by Boundary.

This top-level repository provides limited common tasks, such as installation and commit assistance. However, most tasks must be executed from within a subproject, e.g. running or testing.

Table of Contents generated with DocToc

• Prerequisites
• Installation
• Yarn Commands
• Contributing
  • Branching
  • Building ToC
  • Building Admin UI for Production
    • Building with a Container
  • Building Desktop UI for Production
  • Connect Boundary UI to Boundary local instance
    • For admin
    • For desktop
  • Committing
    • License Checking

Prerequisites

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

• Git
• Node.js
  • Supported versions:v12, v14 and v16.
  • Apple Silicon Users: if you experience problems building or running Boundary UIs, try Node v14.
• Yarn installed globally
• Google Chrome
• Firefox

Installation

• git clone <repository-url> this repository
• cd boundary-ui
• yarn install

Yarn Commands

List of available project commands. yarn run <command-name>

Contributing

Branching

We follow GitHub Flow.

Building ToC

To autogenerate a ToC (table of contents) for this README, run yarn doc:toc. Please update the ToC whenever editing the structure of README.

Building Admin UI for Production

See ui/admin/README.md Building for Production for more information on how to build the Admin UI. Be sure to set build-related environment variables as necessary for your target environment, as described in the Admin UI readme.

To quickly produce a production build of Admin UI, run from this folder:

yarn install
yarn build

Assets are saved to ui/admin/dist/.

Building with a Container

Optionally, you may build the UI within a container. Execute the following command:

docker-compose -f docker-compose-embedding.yml run build

Assets are saved to ui/admin/dist/.

Building Desktop UI for Production

See ui/desktop/README.md Building for Production for more information on how to build the Desktop UI. Be sure to set build-related environment variables as necessary for your target environment, as described in the Desktop UI readme.

To quickly produce a production build of Desktop UI, run from this folder:

yarn install
yarn build:ui:desktop

In windows, UI is generated using docker to provide a stable UI across platforms.

yarn install
docker-compose -f docker-compose-embedding.yml run build-desktop-production 
yarn build:ui:desktop:app

To provide a signing identify for macOS build, use BOUNDARY_DESKTOP_SIGNING_IDENTITY environment variable to set signing certificate name (e.g Developer ID Application: * (*)) when building desktop app using yarn build:ui:desktop:app.

Assets are saved to ui/desktop/electron-app/out/make/. DMG packaged desktop UI is available at asset location as boundary.dmg. EXE archived desktop UI is available at asset location under zip folder.

Connect Boundary UI to Boundary local instance

This describes how to connect local Boundary UI to your local instance of Boundary.

This assumes you already have up and running a Boundary dev instance in your local environment with a listener 127.0.0.1:9200 (default behaviour). Learn how to start a local Boundary dev instance.

For admin

This assumes you are within boundary-ui/ui/admin.

You will need to turn off mirage, tell the UI where to find Boundary and run it: $ ENABLE_MIRAGE=false API_HOST=http://localhost:9200 yarn start.

Following terminal instructions, open in your browser: http://localhost:4200/.

Once you open the UI you will see the login screen, authenticate using generated admin login name and password.

For desktop

This assumes you are within boundary-ui/ui/desktop.

You will need to turn off mirage and run it: $ ENABLE_MIRAGE=false yarn start:desktop.

In login screen, authenticate using generated admin login name and password.

Enter the cluster URL of your Boundary dev instance, by default is: http://localhost:9200.

Committing

We use husky and lint-staged to ensure linting and other checks pass before a commit is completed. Simply do a yarn install to make sure the hooks are installed.

Use a normal git commit to go through the checks, if you need to skip these checks, use git commit --no-verify to bypass them. However, a consistent commit message will still be enforced even if you use --no-verify.

License Checking

The licenses of dependencies are checking against an allowlist before every commit. This helps catch undesirable licenses sooner (e.g. GPL). If your commit fails due to a non-allowlisted license, you may add it to the allowlist in package.json as long as it is not a GPL variant or UNLICENSED. The change will be verified upon PR. GPL variants and UNLICENSED dependencies will not be accepted.