History

John Cowen ac65aa80c6 ui: Remove storybook, add docfy (#9831 ) This PR removes storybook and adds docfy and uses docfy to render our existing README files. This now means we can keep adding README documentation without committing any specific format or framework. If we eventually move to storybook then fine, or if we just want to remove docfy for whatever reason then fine - we will still have a full set of README files viewable via GitHub.		2021-03-08 12:22:01 +00:00
..
packages/consul-ui	ui: Remove storybook, add docfy (#9831 )	2021-03-08 12:22:01 +00:00
.gitignore	…
GNUmakefile	Trailing ui/vercel fixes (#9633 )	2021-01-25 14:02:45 -05:00
README.md	…
package.json	…
vercel.json	Update UI staging build for vercel hosting (#9628 )	2021-01-25 13:46:20 -05:00
yarn.lock	ui: Remove storybook, add docfy (#9831 )	2021-03-08 12:22:01 +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
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.