Kaoto

<h1 align="center"> <a href="https://kaoto.io/"><img src="./packages/ui/src/assets/logo-kaoto.png" alt="Kaoto"></a> </h1> <p align=center> <a href="https://kaoto.io"><img src="https://img.shields.io/badge/Kaoto.io-Visit-white?color=indigo&style=for-the-badge" alt="The Integration Designer for Apache Camel"/></a> <a href="https://kaotoio.github.io/kaoto/"><img src="https://img.shields.io/badge/Kaoto_Online-Open-white?color=yellow&style=for-the-badge" alt="Kaoto Online"/></a> <a href="https://www.youtube.com/@KaotoIO"><img src="https://img.shields.io/badge/Youtube-Follow-brightgreen?color=red&style=for-the-badge" alt="Follow on Youtube"></a> <a href="https://github.com/KaotoIO/kaoto/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache--2.0-white?color=blue&style=for-the-badge" alt="License"/></a> <a href="https://camel.zulipchat.com/#narrow/stream/441302-kaoto"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen?color=blue&style=for-the-badge" alt="Zulip"/></a> </p> <h2 align="center">Kaoto - The Integration Designer for <a href="https://camel.apache.org">Apache Camel</a></h2> <p align="center"> <a href="#feature-highlights">Features</a> • <a href="#requirements">Requirements</a> • <a href="https://kaoto.io/docs/installation">Documentation</a> • <a href="https://kaoto.io/workshop/">Workshops</a> • <a href="https://kaoto.io/contribute/">Contribute</a> • <a href="https://camel.zulipchat.com/#narrow/stream/441302-kaoto">Chat</a> </p> <p align="center"> <a href="https://www.kaoto.io">Kaoto</a> lowers the barrier to getting started with <a href="https://camel.apache.org">Apache Camel</a>, enabling users to quickly prototype and integrate systems without deep Camel knowledge or complex Java coding. With a modern, open-source visual designer, Kaoto empowers teams to build and test integrations efficiently in a low-code environment, accelerating the development process. </p><br/> <p align="center"><img src="./assets/readme/intro-kaoto.png" alt="Shows Kaoto - The Integration Designer for Apache Camel" width="90%"/></p>

Feature Highlights

<p align="center"><i>Kaoto has been designed with a focus on enabling users to quickly prototype Apache Camel integrations without deep Camel knowledge or having to write complex Java code.</i></p> <table> <tr> <td width="33%" align="center"> <img src="./assets/readme/features-list/camel-logo.png" width="40" alt=""/><br/> <b>Based on Apache Camel</b><br/> _{Kaoto utilizes the Apache Camel models and schemas to always offer you all available upstream Camel features.} </td> <td width="33%" align="center"> <img src="./assets/readme/features-list/vscode.png" width="40" alt=""/><br/> <b>VS Code Extension</b><br/> _{Kaoto comes as an extension you can easily install from the <a href="https://marketplace.visualstudio.com/items?itemName=redhat.vscode-kaoto">VS Code Marketplace</a>. Install it directly from inside your VS Code instance.} </td> <td width="33%" align="center"> <img src="./assets/readme/features-list/developers.png" width="40" alt=""/><br/> <b>Care About Developers</b><br/> _{Kaoto is a low-code / no-code visual editor for Apache Camel integrations. Using Kaoto will lower the barrier for integration developers to get started with Apache Camel.} </td> </tr> <tr> <td width="33%" align="center"> <img src="./assets/readme/features-list/open-source.png" width="40" alt=""/><br/> <b>Free Libre and Open Source</b><br/> _{Truly open with no vendor lock-in. Use, reuse, share, modify, and resell to your needs. Own Kaoto and make it yours, making sure your use cases are covered.} </td> <td width="33%" align="center"> <img src="./assets/readme/features-list/catalog.png" width="40" alt=""/><br/> <b>Built-In Catalog</b><br/> _{Kaoto provides you access to a catalog of 300+ Camel Components, 200+ Kamelets and a variety of Enterprise Integration Patterns to choose from. Each comes with documentation to help you get started.} </td> <td width="33%" align="center"> <img src="./assets/readme/features-list/prototyping.png" width="40" alt=""/><br/> <b>Rapid Prototyping</b><br/> _{Building your integration while running it in parallel in Dev Mode gives you a quick turnaround on your changes and enables you to quickly prototype your Camel routes.} </td> </tr> </table>

---

<table><tr> <td valign="middle" width="40%"> <h3>Visual Integration Editor</h3> Design your Camel routes, Kamelets and Pipes in a visual low-code / no-code way. Drag and drop components, connect them together, and see your integration flow come to life. </td> <td width="60%"> <img src="./assets/readme/features-showcase/visual-editor.png" alt="Visual Integration Editor" width="100%"/> </td> </tr></table>

---

<table><tr> <td width="60%"> <img src="./assets/readme/features-showcase/catalog.png" alt="Built-in Catalog" width="100%"/> </td> <td valign="middle" width="40%"> <h3>Built-in Catalog</h3> Browse the comprehensive built-in catalog containing a vast number of available Camel Components (Connectors), Enterprise Integration Patterns as well as Kamelets provided by Apache Camel. </td> </tr></table>

---

<table><tr> <td valign="middle" width="40%"> <h3>Easy Configuration</h3> Selecting a figure on the graphical canvas will open up a configuration form to the right side which allows you to easily configure your components without writing code. </td> <td width="60%"> <img src="./assets/readme/features-showcase/configuration.png" alt="Easy Configuration" width="100%"/> </td> </tr></table>

---

<table><tr> <td width="60%"> <img src="./assets/readme/features-showcase/datamapper.png" alt="Data Mapping & Transformation" width="100%"/> </td> <td valign="middle" width="40%"> <h3>Built-in Data Mapping</h3> Use the Kaoto DataMapper to map data between input and output structures and to transform it to your needs. Visually connect fields and apply transformations without writing complex code. </td> </tr></table>

---

<table><tr> <td valign="middle" width="40%"> <h3>Powerful Sidebar Views</h3> Browse integration files, orchestrate running Camel integrations, initialize new routes, export as Maven projects for Quarkus or Spring Boot, run locally, and deploy to OpenShift/Kubernetes - all from dedicated sidebar views. </td> <td width="60%"> <img src="./assets/readme/features-showcase/sidebar.png" alt="Sidebar Views" width="100%"/> </td> </tr></table>

---

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

Kaoto Online

Have a quick look at our online demo instance: <a style="font-weight: bold" href="https://red.ht/kaoto">https://red.ht/kaoto</a>

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

⚠️ Microsoft Internet Explorer and Safari are 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

<p align="center"> <a href="https://redhat.com"><img style="margin: 50px 0px 50px 0px; " src="assets/redhat-sponsor.jpeg"/></a> </p>