History

John Cowen 077520c247 ui: Change title helper to page-title (#9211 )		2020-11-18 11:11:30 +00:00
..
packages/consul-ui	ui: Change title helper to page-title (#9211 )	2020-11-18 11:11:30 +00:00
.gitignore	ui: Move gitignore file to workspace root and add storybook ignores (#9120 )	2020-11-06 14:50:39 +00:00
GNUmakefile
package.json
README.md
yarn.lock	ui: Topology Intentions Popovers (#9137 )	2020-11-12 10:40:15 -05: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.

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.