Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.13 KB

README.md

File metadata and controls

79 lines (52 loc) · 2.13 KB

Assisted Installer User Interface Library

React component library for https://github.com/openshift-assisted/assisted-ui.

Please note, the project's upstream has been renamed and moved from mareklibra/facet-lib to https://github.com/openshift-assisted/assisted-ui-lib in December 2020.

NPM JavaScript Style Guide

Install

npm install --save openshift-assisted-ui-lib

or

yarn add openshift-assisted-ui-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 assisted-ui application's node_modules.

yarn sync-to-ui

# eventually:
ASSISTED_UI_ROOT=../assisted-ui UHC_PORTAL=../uhc-portal ./scripts/sync-dist.sh # listen to changes and sync the "./dist" with assisted-ui and uhc-portal 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.

Troubleshooting

Increasing the amount of inotify watchers

If you see the following error: Error: ENOSPC: System limit for number of file watchers reached, you will need to increase the number of inotify watchers.
From the terminal run the following commands:

$ sudo sh -c "echo fs.inotify.max_user_watches=524288 >> /etc/sysctl.conf"
$ sudo sysctl -p

License

Apache-2.0