This is the frontend application for Insights Inventory. It is based on the insights-frontend-starter-app.
There is a comprehensive quick start guide in the Storybook Documentation to setting up an Insights environment complete with:
- A frontend application
- Insights Chroming
- [Insights Proxy]
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 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
-
npm install
-
npm run start
- starts webpack bundler and serves the files with webpack dev server
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
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
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.
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
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
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