Assisted Installer User Interface Library
Install
npm install --save openshift-assisted-ui-lib
or
yarn add openshift-assisted-ui-lib
Development
Prerequisites
This project depends on the following package
-
sudo dnf install -y inotify-tools
Instructions
You can use the following steps in order to set up your dev environment.
- Create a parent directory, e.g.
~/Projects
. - Create your own fork of this repo and
git clone
it.-
cd ~/Projects git clone https://github.com/openshift-assisted/assisted-ui-lib.git
-
- Install the project dependencies:
-
yarn --cwd=./assisted-ui-lib/ install
-
- Fork and clone these projects too, they act as the main app:
- assisted-ui (a light-weight stand-alone app consuming this project),
- uhc-portal (the full OCM app, GitLab access needed).
- These scripts start the project in watch mode:
-
# Watches for changes in the `/src` folder and bundles the files into `/dist` folder yarn start # Synchronizes `/dist` with `node_modules/openshift-assisted-ui-lib/` folder in . yarn sync-dist
-
- This project uses the
assisted-ui
project to ease the development experience outside OCM (akauhc-portal
), follow the instructions in those projects in order to access the app's UI.
Publish
To publish a new version of the package to npmjs.com
- Create a new branch from
master
in this repo, calledrelease/v<some-semver-string>
. - Draft a new release through GitHub's interface.
- Fill the form with the following details:
- Tag:
v<some-semver-string>
- Target branch:
release/v<some-semver-string>
(same as in step 2 above). - Title:
v<some-semver-string>
- Description: Generate the release notes automatically (or edit the field manually)
- Tag:
Updating the API types
The types used by Assisted Installer UI are defined in src/common/api/types.ts
and they are
generated automatically by running yarn update-api
.
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
i18n
See i18n for information on our internationalization tools and guidelines
License
Apache-2.0