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
You will need the following things properly installed on your computer.
- Git
- Node.js
- Pnpm installed globally
- Google Chrome
- Firefox
git clone https://github.com/hashicorp/consul.gitthis repositorycd uipnpm i
List of available project commands. pnpm run <command-name>
| Command | Description |
|---|---|
| doc:toc | Re-builds the ToC for this README. |
| compliance:licenses | Checks that all dependencies have CE-compatible licenses. |
To autogenerate a ToC (table of contents) for this README,
run pnpm doc:toc. Please update the ToC whenever editing the structure
of README.