consul/ui
John Murret ee82e1d01e
ci: remove test-integrations CircleCI workflow (#16928) (#17049)
* remove all CircleCI files

* remove references to CircleCI

* remove more references to CircleCI

* pin golangci-lint to v1.51.1 instead of v1.51
2023-04-19 11:28:59 -06:00
..
packages ci: remove test-integrations CircleCI workflow (#16928) (#17049) 2023-04-19 11:28:59 -06:00
.gitignore
.nvmrc
GNUmakefile Don't `--focus` for dist-vercel 2022-10-13 16:43:54 +02:00
README.md
package.json [UI]: update Ember to 3.27 (#16227) 2023-02-10 13:32:19 -08:00
vercel.json
yarn.lock Backport of UI: Fix htmlsafe errors throughout the app into release/1.15.x (#16591) 2023-03-16 23:21:42 +00: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.