README.md
1# Consul UI Monorepo
2
3This monorepo contains multiple projects, the UI for Consul and addons and
4packages used by the UI.
5
6This top-level repository provides limited common tasks, such as installation
7and commit assistance. However, most tasks must be executed from within a
8subproject, e.g. running or testing.
9
10
11<!-- START doctoc generated TOC please keep comment here to allow auto update -->
12<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
13**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
14
15- [Prerequisites](#prerequisites)
16- [Installation](#installation)
17- [Yarn Commands](#yarn-commands)
18- [Contributing](#contributing)
19 - [Building ToC](#building-toc)
20
21<!-- END doctoc generated TOC please keep comment here to allow auto update -->
22
23## Prerequisites
24
25You will need the following things properly installed on your computer.
26
27* [Git][git]
28* [Node.js][node]
29* [Yarn][yarn] installed globally
30* [Google Chrome][chrome]
31* [Firefox][firefox]
32
33[git]: https://git-scm.com/
34[node]: https://nodejs.org/
35[yarn]: https://classic.yarnpkg.com/lang/en/
36[chrome]: https://google.com/chrome/
37[firefox]: https://firefox.com/
38[yarn-workspaces]: https://classic.yarnpkg.com/en/docs/workspaces/
39
40## Installation
41
42* `git clone https://github.com/hashicorp/consul.git` this repository
43* `cd ui`
44* `yarn`
45
46## Yarn Commands
47
48List of available project commands. `yarn run <command-name>`
49
50| Command | Description |
51|---------------------|------------------------------------|
52| doc:toc | Re-builds the ToC for this README. |
53| compliance:licenses | Checks that all dependencies have OSS-compatible licenses. |
54
55## Contributing
56
57### Building ToC
58
59To autogenerate a ToC (table of contents) for this README,
60run `yarn doc:toc`. Please update the ToC whenever editing the structure
61of README.
62