Kaoto

Feature Highlights

---

---

---

---

---

---

Table of Contents

• Kaoto
  • Kaoto Online
  • Requirements
  • Getting Started
    • Clone the Repository
    • Install Dependencies
  • Running Kaoto with Docker
  • Development
    • Web Application
      • Run
      • Build
    • Public Components
  • Storybook
  • Documentation

Kaoto Online

Have a quick look at our online demo instance: https://red.ht/kaoto

Kaoto Extension

Let's try also our Visual Studio Code extension from the VS Code Marketplace or Open VSX Registry

Requirements

Development Requirements

• NodeJS (v22.x or higher) +info
• Yarn (v3.x or higher) +info

ℹ️ For more information on Vite, check Vite's documentation.

Browser Requirements

• Mozilla Firefox
• Google Chrome
• Microsoft Edge
• Safari (experimental)

⚠️ Microsoft Internet Explorer is not supported

Getting Started

Clone the Repository

First, clone the repository to your local machine.

git clone https://github.com/KaotoIO/kaoto

Install Dependencies

Navigate to the cloned directory and install the necessary packages.

cd kaoto
yarn install

Note: By default, @kaoto/camel-catalog will also be built using the mvn wrapper.

Running Kaoto with Docker

For trial purposes, there is a docker image that can be run locally:

docker run --rm -p 8080:8080 --name kaoto quay.io/kaotoio/kaoto-app:main

Development

Web Application

Run

To start the development server, execute the following command:

yarn workspace @kaoto/kaoto run start

The application will be accessible at http://localhost:5173 by default.

Build

To build the web application, execute:

yarn workspace @kaoto/kaoto run build

Public Components

To build the public components, execute:

yarn workspace @kaoto/kaoto run build:lib

Storybook

To view the storybook stories, go to Chromatic. The stories are built for non-Dependabot pull requests and the link to storybook generated for PR is linked once the storybook is published. You can learn more about how to create a story for your UI component here.

To run Storybook locally:

# first build the ui library
yarn workspace @kaoto/kaoto build:lib

# run the storybook
yarn workspace @kaoto/kaoto-tests storybook

To publish to Chromatic: yarn workspace @kaoto/kaoto-tests chromatic

Documentation

• Glossary -- canonical terminology for Kaoto's visual editor and DSL concepts.
• Contributing -- guidelines for contributing to Kaoto.

---