History

John Cowen ad4d3152fe ui: Add CustomElement Transform (#12540 ) This PR adds an Ember-Glimmer/Handlebars transform to drop the documentation copy from the CustomElement component out of the build, therefore it is not bundled into the code either at development time or production build time.		2022-03-11 10:25:21 +00:00
..
packages	ui: Add CustomElement Transform (#12540 )	2022-03-11 10:25:21 +00:00
.gitignore
GNUmakefile	ci: Only install UI dependencies for CI frontend-cache (#11313 )	2021-10-14 15:14:26 +01:00
package.json	ui: Start using mermaid state diagrams in our docs (#12350 )	2022-02-17 14:57:14 +00:00
README.md	ui: Add initial "How 2 Test UI" docs (#11296 )	2021-10-26 19:18:03 +01:00
vercel.json
yarn.lock	ui: Start using mermaid state diagrams in our docs (#12350 )	2022-02-17 14:57:14 +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.

If you are looking to work on the Consul UI you probably want to read the README that is in ./packages/consul-ui/README.md.

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.