open-consul/ui
John Cowen cb7dbd0f87
ui: Add docs for `<Action />` component (#12502)
2022-03-03 12:59:25 +00:00
..
packages ui: Add docs for `<Action />` component (#12502) 2022-03-03 12:59:25 +00:00
.gitignore ui: Support Route optional parameters/segments (#10212) 2021-05-26 17:43:46 +01:00
GNUmakefile ci: Only install UI dependencies for CI frontend-cache (#11313) 2021-10-14 15:14:26 +01:00
README.md ui: Add initial "How 2 Test UI" docs (#11296) 2021-10-26 19:18:03 +01:00
package.json ui: Start using mermaid state diagrams in our docs (#12350) 2022-02-17 14:57:14 +00:00
vercel.json Update UI staging build for vercel hosting (#9628) 2021-01-25 13:46:20 -05:00
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

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.
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.