hashicc
c5fdbfd62d
* chore: 🤖 add .eslintignore for e2e-tests directory * chore: 🤖 add auto-fixable eslint changes * chore: 🤖 make js tasks more explicit to avoid race conditions avoid having js files be in two separate concurrent branches where tasks could result in race-condition writes * chore: 🤖 expand .eslintignore to include more generated dirs * chore: 🤖 fix additional lint-staged tasks Fix additional lint-staged tasks that could result in race conditions
Admin UI
The Admin UI for Boundary.
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:development | Builds the Admin UI in development mode. |
| build | Builds the Admin 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
ember serve- Visit your app at http://localhost:4200.
- Visit your tests at http://localhost:4200/tests.
Building for Production
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 install
yarn build
The static production assets are saved into the dist/ folder.
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 testruns full tests in random order with coverageember 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.