History

Tyler Wendlandt c55ec2823b Merge pull request #15153 from hashicorp/ui/chore/update-icons-to-use-flight-icons-component ui: update icons to use flight icons component		2022-10-27 15:21:56 -06:00
..
packages	Merge pull request #15153 from hashicorp/ui/chore/update-icons-to-use-flight-icons-component	2022-10-27 15:21:56 -06: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: Move nvmrc to the root of the workspace (#14567 )	2022-09-29 09:41:57 -07:00
GNUmakefile	Don't `--focus` for dist-vercel	2022-10-13 16:43:54 +02:00
README.md	ui: Add initial "How 2 Test UI" docs (#11296 )	2021-10-26 19:18:03 +01:00
package.json	ui: Move peers to a subapplication (#13725 )	2022-07-14 11:22:45 +01:00
vercel.json	…
yarn.lock	Use FlightIcon component for external sources	2022-10-24 13:39:28 -06: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
Installation
Yarn Commands
Contributing
- Building ToC

Prerequisites

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

Git
Node.js
Yarn installed globally
Google Chrome
Firefox

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.