Git Product home page Git Product logo

insights-inventory-frontend's Introduction

Build Status

Insights Inventory Frontend

This is the frontend application for Insights Inventory. It is based on the insights-frontend-starter-app.

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 the inventory app due to the consumption of the chroming service as well as setting up your global/app navigation through the API.

Insights Proxy

Insights Proxy is required to run the inventory frontend application. Note that a inventory-specific proxy configuration is required for now for the frontend application to be able to talk to the Inventory API POC. To run the proxy with inventory-specific configuration run:

SPANDX_CONFIG="$(pwd)/insights-inventory-frontend/config/spandx.config.js" bash insights-proxy/scripts/run.sh

Running the app

  1. npm install

  2. npm run start

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

Running the app without insights-proxy

You don't have to run insights proxy to serve your application, you can use built in webpack-proxy by running

npm run start:proxy

Running in beta environment

If you want to run inventory app in beta environment accessible on /beta/insights/inventory you can do that by add BETA=true before each start command

BETA=true npm start

or

BETA=true npm run start:proxy

or building for beta environment

BETA=true npm run build

Running with another app

If you want to see changes made in inventory table in another application you will have to run both inventory and desired application. We'll take for example insights-advisor-frontend application as app that uses system detail.

With insights proxy

Run the inventory application

npm start

Open new terminal and navigate to desired application (for instance insights-adviror-frontend) and run it (make sure to run it on different port)

npm start

Open new terminal, navigate to insights-proxy and run it with

LOCAL_API=advisor:8003~https SPANDX_CONFIG="$(pwd)/insights-inventory-frontend/config/spandx.config.js" bash insights-proxy/scripts/run.

If you want to run advisor and for instance vulnerability just add new entry to LOCAL_API

LOCAL_API=advisor:8003~https,vulnerability:8004

With webpack proxy

Open new terminal and navigate to desired application (for instance insights-adviror-frontend) and run it (make sure to run it on different port)

npm start

Run the inventory application with proxy enabled and list of additional applications

LOCAL_API=advisor:8003~https npm run start:proxy

If you want to run advisor and for instance vulnerability just add new entry to LOCAL_API

LOCAL_API=advisor:8003~https,vulnerability:8004

Testing

There is an npm script that runs the build, JS and CSS linters and unit tests. The script can be invoked by npm run verify

insights-inventory-frontend's People

Contributors

dependabot-preview[bot] avatar karelhala avatar rvsia avatar ryelo avatar jharting avatar allenbw avatar dependabot[bot] avatar hyperkid123 avatar iphands avatar dlobatog avatar jiridostal avatar arivepr avatar kgaikwad avatar jjaquish avatar blakeholifield avatar bmclaughlin avatar fhlavac avatar mayurilahane avatar panspagetka avatar kruai avatar mkholjuraev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.