History

John Cowen b07ff88874 ui: Add documentation link for partitions (#11668 )		2021-12-06 10:09:44 +00:00
..
packages	ui: Add documentation link for partitions (#11668 )	2021-12-06 10:09:44 +00:00
.gitignore	…
GNUmakefile	…
README.md	…
package.json	ui: Move nspace CRUD to use the same approach as partitions (#11633 )	2021-12-01 11:04:02 +00:00
vercel.json	…
yarn.lock	ui: Support for SSO with Admin Partitions (#11604 )	2021-11-24 14:53:12 +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.