Interactive component documentation and stories are available on Chromatic:
- Master branch: https://master--687a10bbc18d4b17063770ba.chromatic.com
- Feature branches: https://
<branch-name>--687a10bbc18d4b17063770ba.chromatic.com
Stories are automatically deployed on:
- ✅ Pushes to
master - ✅ Pull requests from @RedHatInsights/experience-ui-committers team members
- ✅ Pull requests from RedHatInsights organization admins
This application exposes components via module federation for use by other Red Hat Console applications.
See the Module Federation Guide for available modules, usage examples, and API reference.
This repository is now using experimental workflow checks. Your commits must use the conventional commits format.
This project requires Node.js LTS (currently Node.js 20.x) for both local development and CI/CD. Using other Node.js versions may cause compatibility issues, particularly with Storybook builds.
Important: The project uses CommonJS modules for Storybook configuration and requires Node.js LTS for proper module resolution and TypeScript compilation.
# Check your Node.js version
node --version
# If you need to switch to LTS, use nvm or your preferred version manager
nvm use --ltsnpm install
npm run startThis project includes several npm scripts that automate various tasks. Below are descriptions of some of the most commonly used scripts:
Starts the development server. This script will compile your code and open a browser window displaying the application. It also sets up hot reloading so changes in your code are reflected instantly.
Builds the production version of the application. The output will be placed in the dist directory, ready for deployment.
Runs the unit tests suite using Jest.
Runs the Playwright E2E test suite against stage. See e2e/README.md for complete setup instructions including authentication and data seeding.
Runs ESLint to check for code style issues and potential errors in your JavaScript/TypeScript files. It will report any problems found according to the rules defined in the .eslintrc configuration file.
Formats all JavaScript, TypeScript, and other supported files using Prettier. This ensures consistent formatting across the entire project.
This project is available as open source under the terms of the Apache License 2.0.
In order to test current Quickstarts tutorials iteration, you must enable the testing local variable through your browser's console.
localStorage.setItem('quickstarts:enabled', true)
You'll be able to see the buttons for testing both the quickstart tutorial and the catalog page.
Once the flag is enabled, you can access the catalog directly via its route:
.../settings/rbac/quickstarts-test