History

John Cowen 6bc8af364f ui: Add initial i18n docs page (#10888 )		2021-09-22 18:51:39 +01:00
..
packages/consul-ui	ui: Add initial i18n docs page (#10888 )	2021-09-22 18:51:39 +01:00
.gitignore	ui: Support Route optional parameters/segments (#10212 )	2021-05-26 17:43:46 +01:00
GNUmakefile	Trailing ui/vercel fixes (#9633 )	2021-01-25 14:02:45 -05:00
README.md	ui: Add license checker to the workspace plus CI (#9507 )	2021-01-06 18:37:21 +00:00
package.json	ui: Add resolution for xmlhttprequest-ssl at least 1.6.3 (#10370 )	2021-06-21 12:06:44 +01:00
vercel.json	Update UI staging build for vercel hosting (#9628 )	2021-01-25 13:46:20 -05:00
yarn.lock	ui: Remove legacy ACLs (#11096 )	2021-09-22 18:32:51 +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
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.