First time setup
- Make sure you have
- Run script to patch your
- Make sure you are using Red Hat proxy
There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment.
- Install dependencies with
- 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/
Jest is used as the testing framework
npm run test- run all tests
npm run test -- testName- run tests for all components matching
npm run lint- run linter
npm run test:update- run all tests and update snapshots
npm run test:watch- run tests in watch mode
Any push to the following branches will trigger a build in vulnerability-ui-build repository which will deploy to corresponding environment.
|Push to branch in this repo||Updated branch in build repo||Environment||Available at|
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:
This project uses Patternfly React.
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.
This project uses Semantic Versioning. Release process is automated by using Semantic Release.