open-consul/ui
John Cowen 17333e90ce
ui: Storybook Install (#9049)
* ui: Install storybook into the main project

* Add a basic story for a notice

* Remove empty dependencies
2020-11-03 14:09:39 +00:00
..
packages/consul-ui ui: Storybook Install (#9049) 2020-11-03 14:09:39 +00:00
.gitignore ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
GNUmakefile ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
README.md ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
package.json ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
yarn.lock ui: Storybook Install (#9049) 2020-11-03 14:09:39 +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.

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.

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.