Skip to content

vconzola/insights-frontend-storybook

 
 

Repository files navigation

insights-frontend-storybook

Live Version

This is documentation for:

Tech Notes

  • In prod, pre prod, and on local dev environments (insights-proxy) all of the API is accessible via the same hostname that the frontend is served. You dont need to go to api.access* in prod to hit /r/insights/. You can safely call using the path "/r/insights" on the same hostname. So no need to use CORS in your frontend/api.
  • Insights Chrome will handle web frontend authentication challenge, and auth session management for you. If you app is chromed and you are logged in you can expect that a JWT is going back to 3scale automatically and 3scale is handling the validation of that JWT for you. (This is not yet implemented in Chrome, but it is coming soon)

Dev Installation instructions

  1. git clone git@github.com:RedHatInsights/insights-frontend-storybook.git
  2. npm install
  3. (optional) set up insights-proxy
    • only required for insights-chrome's stories to run
  4. Run
    • 'npm run lint' to check linting
    • npm run start to develop storybook pages
    • npm run build to build the storybook, used for testing
  5. Naviage to localhost:6006

Markdown Rules

About

Storybook view and documentation for cloud.redhat.com frontend

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.6%
  • CSS 9.3%
  • Other 1.1%