9eddc48429
This adds a new component blueprint for all our components. We've been using README.mdx files for quite some time to document our components for other engineers. This adds a default file to help new engineers get started writing useful documentation. These README.mdx file are also very useful for building out components in isolation from scratch and and some point will be used to run automated component testing. |
||
|---|---|---|
| .. | ||
| packages | ||
| .gitignore | ||
| GNUmakefile | ||
| package.json | ||
| README.md | ||
| vercel.json | ||
| yarn.lock | ||
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.
- Git
- Node.js
- Yarn installed globally
- Google Chrome
- Firefox
Installation
git clone https://github.com/hashicorp/consul.gitthis repositorycd uiyarn
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.