From fc63fd182c6cb54cae75bab771ca97db350d866d Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Wed, 24 Jun 2020 11:33:20 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20clarify=20producti?= =?UTF-8?q?on=20build=20process=20and=20asset=20location?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +++++ ui/core/README.md | 14 ++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 36823bde6..80c5e1558 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,11 @@ 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 Core UI for Production + +See ui/core/README.md Building for Production for more information on how to +build the Core UI. + ### Committing Instead of the default `git commit`, we prescribe a custom command that ensures diff --git a/ui/core/README.md b/ui/core/README.md index 5bfdb86b4..1414b3ac0 100644 --- a/ui/core/README.md +++ b/ui/core/README.md @@ -58,12 +58,18 @@ List of available project commands. `yarn run ` * Visit your app at [http://localhost:4200](http://localhost:4200). * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). -### Building +### Building for Production -To build the project, without running it, execute one of the following commands: +Before executing a build, be sure to set any environment variables necessary +for your target environment (see next section). To build this UI for +production, run the following commads from this folder: -* `yarn run build` (development) -* `yarn run build:production` (production) +```bash +yarn install +yarn build:production +``` + +The static production assets are saved into the `dist/` folder. #### Environment Variables