You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
consul/ui
Phil Renaud 965ebfb919
[ui] Regenerate yarn lockfile for 1.18 and lower versions (#21714)
2 months ago
..
packages
.gitignore
.nvmrc
GNUmakefile
README.md
package.json [ui] Regenerate yarn lockfile for 1.18 and lower versions (#21714) 2 months ago
vercel.json
yarn.lock [ui] Regenerate yarn lockfile for 1.18 and lower versions (#21714) 2 months ago

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 CE-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.