contributing-code-developing

Developing components of the Radius Dashboard

This page how to run and develop the Radius Dashboard and its components.

Developing: Dashboard

Launch the Dashboard:

Run in separate terminals:

kubectl proxy

yarn dev

You can leave these commands running while you work on the Dashboard. Changes you make will be reflected in the browser pretty immediately.

The Dashboard is configured to look for a Kubernetes API server on localhost:8001. Running kubectl proxy will open a port-forward to your currently-configured Kubernetes cluster.

This will launch the Dashboard at http://localhost:3000.

Configuration

The configuration for local development (yarn dev) is stored in app-config.local.yaml. This file is a set of overrides for development that will be combined with app-config.yaml. See the configuration file comments for links to relevant documentation.

This file is checked in but .gitignored'd. Feel free to make changes as needed.

The app-config.dashboard.yaml configuration is used when deployed as part of a Radius installation.

Frontend qualification

@internal/plugin-radius/alpha is the native Radius frontend entry. The root entry remains available to legacy hosts. The standalone app owns guest sign-in.

Build and qualify the standalone host with:

yarn workspace @internal/app build
NODE_ENV=production yarn test:e2e:standalone

Run the image restore qualification with immutable image identities:

yarn test:e2e:rollback <previous image@digest> <previous revision> <candidate image ID or image@digest> <candidate revision>

Developing: rad-components

Launch Storybook to experiment with rad-components:

yarn workspace @radapp.io/rad-components run storybook

This will launch Storybook at http://localhost:6006.