consul/ui
Ronald bf64a33caa
Remove UI brand-loader copyright headers as they do not render appropriately (#16835)
2023-03-31 11:29:19 -04:00
..
packages Remove UI brand-loader copyright headers as they do not render appropriately (#16835) 2023-03-31 11:29:19 -04:00
.gitignore ui: Replace file-mask with file-text icon usage on policy list (#14275) 2022-08-24 06:44:01 -06:00
.nvmrc UI: update Ember to 3.28.6 (#16616) 2023-03-20 15:41:47 -07:00
GNUmakefile UI: update Ember to 3.28.6 (#16616) 2023-03-20 15:41:47 -07:00
README.md ui: Add initial "How 2 Test UI" docs (#11296) 2021-10-26 19:18:03 +01:00
package.json UI: update Ember to 3.28.6 (#16616) 2023-03-20 15:41:47 -07:00
vercel.json
yarn.lock UI: update Ember to 3.28.6 (#16616) 2023-03-20 15:41:47 -07:00

README.md

Consul UI Monorepo

This monorepo contains multiple projects, the UI for Consul and addons and packages used by the UI.

This top-level repository provides limited common tasks, such as installation and commit assistance. However, most tasks must be executed from within a subproject, e.g. running or testing.

If you are looking to work on the Consul UI you probably want to read the README that is in ./packages/consul-ui/README.md.

Table of Contents generated with DocToc

Prerequisites

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

Installation

  • git clone https://github.com/hashicorp/consul.git this repository
  • cd ui
  • yarn

Yarn Commands

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

Command Description
doc:toc Re-builds the ToC for this README.
compliance:licenses Checks that all dependencies have OSS-compatible licenses.

Contributing

Building ToC

To autogenerate a ToC (table of contents) for this README, run yarn doc:toc. Please update the ToC whenever editing the structure of README.