Vulnerability UI
First time setup
Quick start
- Make sure you have
Node.js
and npm
installed - Run script to patch your
/etc/hosts
- Make sure you are using Red Hat proxy
Comprehensive documentation
There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment.
Running locally
- Install dependencies with
npm install
- Run development server with
npm run start:proxy:beta
- Local version of the app will be available at https://stage.foo.redhat.com:1337/beta/insights/vulnerability/
Testing
Jest is used as the testing framework
npm run test
- run all testsnpm run test -- testName
- run tests for all components matching testName
npm run lint
- run linternpm run test:update
- run all tests and update snapshotsnpm run test:watch
- run tests in watch mode
Deploying
Any push to the following branches will trigger a build in vulnerability-ui-build repository which will deploy to corresponding environment.
Internationalization
Translation keys
Translation keys are saved in messages.js.
Generating translation keys
Each time you add a new translation keys you need to run npm run translations
, which will automatically generate JSON files for every language into locales/
folder based on the entries in the messages.js.
Using translated strings
There are two ways to use translated strings:
- With
intl.formatMessage(messages.messageId)
- With
<FormattedMessage {...messages.messageId}/>
Design System
This project uses Patternfly React.
Insights Components
This app imports components from Insights Front-end Components library. ESI tags are used to import Insights Chrome which takes care of the header, sidebar, and footer.
Versioning
This project uses Semantic Versioning. Release process is automated by using Semantic Release.