docs: ✏️ Enhance desktop UI yarn commands documentation

Enhance desktop UI yarn commands documentation
This commit is contained in:
Carlos Alcaide Corvo committed 2021-10-04 12:54:44 -07:00
1 parent 841495d453
commit d8d22cd787
1 file changed
+11 -5
+11 -5
View File
@@ -1,6 +1,6 @@
# Client Connect UI
# Desktop client UI
The client UI for Boundary.
The desktop client UI for Boundary.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -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 <command-name>`
| 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