Koreo UI

Koreo UI is a lightweight, read-only application that provides a visual representation of your Koreo Workflows and related resources.

Installing

Refer to the Koreo documentation for steps on installing Koreo UI.

Getting Started for Development

Install pnpm

Version 10.2.0 or higher should be used.

Install Dependencies

pnpm install

Authenticate with Kubernetes

Locally, Koreo UI leverages kubeconfig credentials at ~/.kube/config to authenticate with a Kubernetes cluster. Ensure that you have authenticated properly, either with kubectl or, if using a cloud-managed Kubernetes such as GKE, with the respective tooling such as gcloud.

Refer to the Kubernetes documentation for more.

Start the Dev Environment

To run the application in development mode:

pnpm dev

Build

To build the application:

pnpm build

To build the Docker image:

docker build -t koreo-ui .

Start the Production Environment

To run the built application:

pnpm start

Clean Files Before Committing

Ensure pnpm clean is run on any code that is committed:

pnpm clean