Files
threshold-ui/ui/core
..
2020-06-04 13:12:53 -04:00
2020-05-29 17:00:42 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00
2020-05-18 17:02:09 -04:00

Core UI

The core UI for Project Watchtower.

Table of Contents generated with DocToc

Prerequisites

You will need the following things properly installed on your computer.

Installation

See monorepo README for installation instructions.

Yarn Commands

List of available project commands. yarn run <command-name>

Command Description
build Builds the UI in development mode.
build:production 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.
test Runs all tests in random order, with coverage reporting.
doc:toc Automatically generates a table of contents for this README file.

Running / Development

Building

To build the project, without running it, execute one of the following commands:

  • yarn run build (development)
  • yarn run build:production (production)

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.
API_HOST The host of the API, if different than UI (e.g. https://example.net:1234).

Running Tests

  • npm test runs full tests in random order with coverage
  • ember test --server

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

Specify what it takes to deploy your app.