helix-ui
Version:
Web Component Library
47 lines (29 loc) • 1.99 kB
Markdown
[](https://travis-ci.com/HelixDesignSystem/helix-ui)
[](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/build.yml)
[](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/browser-tests.yml)
# HelixUI Web Components Library
The HelixUI Web Components library provides front-end developers a full suite
of web components for building UIs.
Adopting the library will enable developers to build products with consistent
markup, styles, and behavior across a variety of frameworks.
## Documentation
* Homepage - https://helixdesignsystem.github.io/helix-ui/
* Getting Started Guide - https://helixdesignsystem.github.io/helix-ui/guides/getting-started/
* NPM Releases - https://www.npmjs.com/package/helix-ui
## Helix-React Wrappers + React Support
* Our sister repo **Helix-React** - https://github.com/HelixDesignSystem/helix-react - provides
React component wrappers to HelixUI.
* NPM Releases - https://www.npmjs.com/package/@helix-design-system/helix-react
* React Compatiblity with Web Components - https://helixdesignsystem.github.io/helix-ui/guides/react-compatibility/
## Developer Setup
1. Install Yarn - https://yarnpkg.com/en/docs/install
2. `$ git clone git@github.com:HelixDesignSystem/helix-ui.git` (recommended for 2FA setups)
3. `$ cd helix-ui`
4. `$ yarn install` to install project dependencies
5. `$ yarn start`
6. Navigate to `http://127.0.0.1:3000` in your favorite browser
## Run Component Test Suite
### Initial Run (or on code updates)
- `$ yarn test:build` to compile code and run the full component test suite
### Just making changes to tests
- `$ yarn test` to run the full component test suite