facet-lib

React component library for the Bare Metal Installer

Usage no npm install needed!

<script type="module">
  import facetLib from 'https://cdn.skypack.dev/facet-lib';
</script>

README

facet-lib

React component library for https://github.com/openshift-metal3/facet.

NPM JavaScript Style Guide

Install

npm install --save facet-lib

or

yarn add facet-lib

Develop

One time action:

sudo dnf install -y inotify-tools
yarn install

Start webpack dev server to watch sources and keep compiling into /dist:

yarn start

Optionaly, sync /dist to the Facet application's node_modules.

yarn sync-to-facet

# eventually:
FACET_ROOT=../facet ./scripts/sync-dist.sh # to sync the "./dist" into facet's node_modules

Publish

To publish the Node.js package, simply create a new tag in format v[VERSION].

To do so, preferably draft a new release with:

  • tag: v[VERSION], example: v1.2.3
  • title: v[VERSION], example: v1.2.3

New version of the package will be published to npmjs.com and a new PR with version change will be created automatically by a GitHub action.

License

Apache-2.0