consul/ui
John Cowen 4e420df7ae
ui: Adds QUnit toggle bookmarklet to our docs (#10269)
2021-05-20 16:24:50 +01:00
..
packages/consul-ui ui: Adds QUnit toggle bookmarklet to our docs (#10269) 2021-05-20 16:24:50 +01:00
.gitignore
GNUmakefile
README.md
package.json ui: Bump node to v14 (#10238) 2021-05-18 16:30:19 +01:00
vercel.json
yarn.lock ui: Use babel plugin to strip calls to runInDebug (#10237) 2021-05-17 13:27:34 +01: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.

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.