diff --git a/README.md b/README.md index 36823bde6..4c200c5e6 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ subproject, e.g. running or testing. - [Contributing](#contributing) - [Branching](#branching) - [Building ToC](#building-toc) + - [Building Core UI for Production](#building-core-ui-for-production) - [Committing](#committing) - [License Checking](#license-checking) @@ -100,6 +101,21 @@ 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. Be sure to set build-related environment variables as +necessary for your target environment, as described in the Core UI readme. + +To quickly produce a production build of Core UI, run from this folder: + +```bash +yarn install +yarn build:production:core +``` + +Assets are saved to `ui/core/dist/`. + ### Committing Instead of the default `git commit`, we prescribe a custom command that ensures diff --git a/package.json b/package.json index f121c3503..17d23d120 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,7 @@ "ui/*" ], "scripts": { + "build:production:core": "cd ui/core && yarn build:production", "lint": "yarn lint:addons:api && yarn lint:addons:auth && yarn lint:addons:rose && yarn lint:ui:core", "lint:addons:api": "echo \"\n\nlint: addons/api\n\" && cd addons/api && yarn lint", "lint:addons:auth": "echo \"\n\nlint: addons/auth\n\" && cd addons/auth && yarn lint", diff --git a/ui/core/README.md b/ui/core/README.md index 5bfdb86b4..9fe164967 100644 --- a/ui/core/README.md +++ b/ui/core/README.md @@ -10,7 +10,7 @@ The core UI for Project Watchtower. - [Installation](#installation) - [Yarn Commands](#yarn-commands) - [Running / Development](#running--development) - - [Building](#building) + - [Building for Production](#building-for-production) - [Environment Variables](#environment-variables) - [Running Tests](#running-tests) - [Deploying](#deploying) @@ -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