/malware-detection-frontend

Frontend for the Insights Yara (aka: cautious-octo-garbanzo) Application

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Build Status

malware-detection-frontend

Malware Detection 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 malware-detection-frontend app due to the consumption of the chroming service as well as setting up your global/app navigation through the API

Developing

First time setup

  1. Make sure you have Node.js and npm installed
  2. Run script to patch your /etc/hosts
  3. Make sure you are using Red Hat proxy
  4. Clone this repository
  5. Run npm install to install dependencies

Running the application

  1. npm run start

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

    OR

  2. npm run start:beta

    • with CI beta env
  3. visit https://prod.foo.redhat.com:1337/insights/malware/ OR https://prod.foo.redhat.com:1337/beta/insights/malware/ for beta env

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

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 (only necessary if your not using start:proxy)

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

Have yara-backend installed and run docker-compose up