Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.58 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.58 KB

Build Status

yara-frontend

Yarap for Red Hat Insights products that includes Patternfly 4 and shared cloud.redhat.com utilities.

Getting Started

There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment complete with:

Note: You will need to set up the Insights environment if you want to develop with the yara-frontend app due to the consumption of the chroming service as well as setting up your global/app navigation through the API.

Build app

  1. npm install

  2. npm run start

    • starts webpack bundler and serves the files with webpack dev server

Testing

  • npm run verify will run linters and tests

  • Travis is used to test the build for this code.

    • You are always notified on failed builds
    • You are only notified on successful builds if the build before it failed
    • By default, both push events as well as pull_request events send notifications
    • Travis is defaulted to notify #insights-bots

    Sitemap

    • When you run the build it also triggers sitemap generation and sitemap.xml is created.
    • You need to have routes configured in package.json otherwise sitemap will be empty.

Deploying

  • The Platform team is using Travis to deploy the application
    • The Platform team will help you set up the Travis instance if this is the route you are wanting to take

Running locally

Have insights-proxy installed under PROXY_PATH

SPANDX_CONFIG="./profiles/local-frontend.js" bash $PROXY_PATH/scripts/run.sh

Testing - jest

When you want to test your code with unit tests please use jest which is preconfigured in a way to colect codecoverage as well. If you want to see your coverage on server the travis config has been set in a way that it will send data to codecov.io the only thing you have to do is visit their website (register), enable your repository and add CODECOV_TOKEN to your travis web config (do not add it to .travis file, but trough travis-ci.org)