mirror of
https://github.com/status-im/consul.git
synced 2025-01-09 21:35:52 +00:00
25f3ebd66a
Builds on attach-shadow, adopt-styles and ShadowTemplate, this commit adds ShadowHost and finally CustomElement. CustomElement is a renderless component to help with the creation of native HTML Custom Elements along with runtime type checking and self-documentation for attributes, slots, cssprops and cssparts. As you will probably see there is a little more work to come here. But in the same breath, everything would be fine to go in as is.
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.