History

kenia 703869603e review note fixes		2021-04-15 09:19:22 -04:00
..
packages/consul-ui	review note fixes	2021-04-15 09:19:22 -04:00
.gitignore	ui: Move gitignore file to workspace root and add storybook ignores (#9120 )	2020-11-06 14:50:39 +00: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: Dependency Upgrade (#9907 )	2021-03-19 15:14:07 +00:00
vercel.json	Update UI staging build for vercel hosting (#9628 )	2021-01-25 13:46:20 -05:00
yarn.lock	ui: Reformat MaxTokenTTL to sortBy as an integer (#9969 )	2021-04-07 12:43:04 -04: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.