Skip to content

skupperproject/skupper-console

Repository files navigation

alt text

Tests codecov License

Network console V2

alt text

alt text

alt text

alt text

Enable the console from Skupper

The network console works alongside the network observer. Follow the steps outlined in the network observer setup guide to configure a valid route.

Development

We use yarn as the package manager, if adding dependencies to package.json make sure you install them with yarn and commit the yarn.lock file.

Quick start

To get started quickly, follow the steps below:

  1. Install the required dependencies by running yarn install.
  2. Start the application by running yarn start.
  3. Open http://localhost:3000 in your web browser.

Run the Console with external routes

OBSERVER_URL=<network observer console url route> yarn start

Testing

Unit

To run unit tests, use the following command:

yarn test

Integration

To run integration tests, use the following command:

yarn cy

Env variables

  • ``: The console uses a real network observer.
  • API_VERSION: Part of the url api. Note: Do not include a leading slash (/) in the value of API_VERSION.
  • BRAND_APP_LOGO: Customize the logo for the build.
  • BRAND_FAVICON: Customize the favicon for the build.
  • USE_MOCK_SERVER: Use predefined static data to display the console.
  • MOCK_RESPONSE_DELAY: It simulates a delay (milliseconds) in the response when using the mock server.
  • MOCK_ITEM_COUNT: It generates X random resources (processes, sites, links, etc.)