Carlos Alcaide
ec184ff4f1
Update UI's engines in package.json to could use node v15. The change is motivated for apple M1 chip. If you have an apple M1 chip you need to use node v15 to avoid errors while building the UI.
Client Connect UI
The client UI for Boundary.
Table of Contents generated with DocToc
Prerequisites
You will need the following things properly installed on your computer.
Installation
See boundary-ui README for installation instructions.
Yarn Commands
List of available project commands. yarn run <command-name>
| Command | Description |
|---|---|
| build:development | Builds the UI in development mode. |
| build | Builds the UI for production. |
| lint | Runs all lint commands. |
| lint:hbs | Lints hbs template files. |
| lint:js | Lints js files. |
| lint:sass | Lints scss files. |
| format | Runs all auto-formatters. |
| format:js | Auto-formats js files using Prettier. |
| format:sass | Auto-formats scss files using Prettier. |
| start | Runs the dummy app local server. |
| start:desktop | Runs the dummy app as an electron app. |
| test | Runs all tests in random order, with coverage reporting. |
| doc:toc | Automatically generates a table of contents for this README file. |
Running / Development
yarn start- Visit your app at http://localhost:4200.
- Visit your tests at http://localhost:4200/tests.
To run as a desktop app:
yarn start:desktop
The Boundary CLI is downloaded and extracted to electron-app/cli/ folder as part of
build. CLI version is defined in electron-app/config/cli.js.
Environment Variables
These environment variables may be used to customized the build.
| Variable | Description |
|---|---|
DEBUG_APP_UPDATER |
Enable to debug app updater feature. Must be enabled for all APP_UPDATER_* variables to be used. |
APP_UPDATER_CURRENT_VERSION |
Version of client. |
APP_UPDATER_LATEST_VERSION_TAG |
Next version for comparison with current version. |
APP_UPDATER_LATEST_VERSION_LOCATION |
Location of app release to use for updating client. Can be a filepath or url. |
Building for Production
Before executing a build, be sure to set any environment variables necessary for your target environment. To build this UI for production, run the following commands from this folder:
yarn install
yarn build
BOUNDARY_DESKTOP_SIGNING_IDENTITY environment variable must be provided
to codesign in production.
The static production assets are saved into the dist/ folder.
The Boundary CLI is downloaded and extracted to electron-app/cli/ folder as part of
packaging. CLI version is defined in electron-app/config/cli.js.
Environment Variables
These environment variables may be used to customized the build.
| Variable | Default Value | Description |
|---|---|---|
APP_NAME |
Application Name | The user-facing name of the application, appearing in titles, etc. |
BOUNDARY_DESKTOP_SIGNING_IDENTITY |
The name of the certificate to use when signing (e.g. Developer ID Application: * (*)). |
Running Tests
yarn testruns full tests in random order with coverage
Keep in mind that tests are executed in random order. This is intentional and helps to prevent hard-to-debug order dependencies among tests.
Please also note that we report test coverage. We strive for "the right amount of testing". Use test coverage as a guide to help you identify untested high-value code.
We rely on ember-a11y-testing to validate accessibility in acceptance tests.
If you write acceptance tests, please ensure at least one validation per
route using await a11yAudit();.
Deploying
TBD