From d8d22cd787c98377d4241be908c0df763214fab9 Mon Sep 17 00:00:00 2001 From: Carlos Alcaide Corvo Date: Mon, 4 Oct 2021 12:54:44 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Enhance=20desktop?= =?UTF-8?q?=20UI=20yarn=20commands=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Enhance desktop UI yarn commands documentation --- ui/desktop/README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/ui/desktop/README.md b/ui/desktop/README.md index d706155e1..e4e3af04d 100644 --- a/ui/desktop/README.md +++ b/ui/desktop/README.md @@ -1,6 +1,6 @@ -# Client Connect UI +# Desktop client UI -The client UI for Boundary. +The desktop client UI for Boundary. @@ -31,7 +31,7 @@ You will need the following things properly installed on your computer. ## Installation -See boundary-ui README for installation instructions. +See [boundary-ui README](https://github.com/hashicorp/boundary-ui#installation) for installation instructions. ## Yarn Commands @@ -54,14 +54,19 @@ List of available project commands. `yarn run ` | format:hbs | Auto-formats `hbs` files using Prettier. | | format:js | Auto-formats `js` files using Prettier. | | format:sass | Auto-formats `scss` files using Prettier. | -| start | Runs the dummy app local server. | +| prestart:desktop | Generate forge config file based on platform. | +| start | Runs the dummy app local server as web app. | | start:desktop | Runs the dummy app as an electron app. | +| clean:coverage | Cleans coverage reporting directory. | +| pretest | Runs `clean:coverage`. | | test | Runs all tests in random order, with coverage reporting. | +| test:ember | Runs ember tests in random order, with coverage reporting. | | doc:toc | Automatically generates a table of contents for this README file. | ## Running / Development +To run as web app: * `yarn start` * Visit your app at [http://localhost:4200](http://localhost:4200). * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). @@ -95,11 +100,12 @@ These environment variables may be used to customized the build. | `BYPASS_CLI_SETUP` | Disable download and extraction of cli. For development use only. | | `BYPASS_APP_UPDATER` | Disable app updater feature. For development use only. | | `DISABLE_WINDOW_CHROME` | Disable window chrome. For internal use only. | +| `ENABLE_MIRAGE` | Enable (`true`) or disable (`false`) mirage. Default value is `true`. | ### Building for Production Before executing a build, be sure to set any environment variables necessary -for your target [environment](#environment-variables). To build this UI for +for your target [environment](#environment-variables). To build this UI for production, run the following commands from this folder: ```bash