consul/ui
Chris Hut 75af5b15d9
Cc 7146/convert consul hcp to a simpler component for some upcoming changes (#20344)
* Convert consul-hcp to a simpler component

* update existing test to use envStub helper

* Add missing copyright - weird no one yelled about this

* remove consul-hcp from load

* remove this test that doesn't run anymore
2024-01-26 16:39:50 -08:00
..
packages Cc 7146/convert consul hcp to a simpler component for some upcoming changes (#20344) 2024-01-26 16:39:50 -08:00
.gitignore
.nvmrc Upgrade Consul UI to Node 18 (#19252) 2023-10-23 12:29:04 -06:00
GNUmakefile
README.md
package.json Cc 7146/convert consul hcp to a simpler component for some upcoming changes (#20344) 2024-01-26 16:39:50 -08:00
vercel.json
yarn.lock CC-5545: Side Nav (#19342) 2023-11-06 08:18:48 -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 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.