Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaotoio/kaoto
Next version of the UI of the Kaoto project
https://github.com/kaotoio/kaoto
apache-camel camel camel-k components connectors editor eip integration integration-flow jbang low-code no-code quarkus spring-boot visualisation visualization yaml
Last synced: 5 days ago
JSON representation
Next version of the UI of the Kaoto project
- Host: GitHub
- URL: https://github.com/kaotoio/kaoto
- Owner: KaotoIO
- License: apache-2.0
- Created: 2023-08-07T14:23:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T13:28:59.000Z (7 months ago)
- Last Synced: 2024-04-12T20:17:05.334Z (7 months ago)
- Topics: apache-camel, camel, camel-k, components, connectors, editor, eip, integration, integration-flow, jbang, low-code, no-code, quarkus, spring-boot, visualisation, visualization, yaml
- Language: TypeScript
- Size: 12.5 MB
- Stars: 11
- Watchers: 7
- Forks: 19
- Open Issues: 141
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Visual Editor for Apache Camel
Documentation |
Workshops |
Contribute |
Chat
# Kaoto
Kaoto is a visual editor for Apache Camel integrations. It offers support in creating and editing Camel Routes, Kamelets and Pipes. Kaoto also has a built-in catalog with available Camel components, Enterprise Integration Patterns and Kamelets provided by the Apache Camel community.
Have a quick look at our online demo instance:
https://red.ht/kaoto
## Table of Contents
- [Kaoto](#kaoto)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Clone the Repository](#clone-the-repository)
- [Install Dependencies](#install-dependencies)
- [Running kaoto with Docker](#running-kaoto-with-docker)
- [Development](#development)
- [Web Application](#web-application)
- [Run](#run)
- [Build](#build)
- [Public Components](#public-components)
- [Camel Catalog and Supporting Schemas](#camel-catalog-and-supporting-schemas)
- [Storybook](#storybook)
## Requirements
- NodeJS (v18.x or higher) [+info](https://nodejs.org/en)
- Yarn (v3.x or higher) [+info](https://yarnpkg.com/getting-started/install)
- OpenJDK (v17 or higher) [+info](https://developers.redhat.com/products/openjdk/download)
_For more information on Vite, check [Vite's documentation](https://vitejs.dev/config/)._
## Getting Started
### Clone the Repository
First, clone the repository to your local machine.
```sh
git clone https://github.com/KaotoIO/kaoto
```
### Install Dependencies
Navigate to the cloned directory and install the necessary packages.
```sh
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:
```sh
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:
```sh
yarn workspace @kaoto/kaoto run start
```
The application will be accessible at `http://localhost:5173` by default.
#### Build
To build the web application, execute:
```sh
yarn workspace @kaoto/kaoto run build
```
### Public Components
To build the public components, execute:
```sh
yarn workspace @kaoto/kaoto run build:lib
```
## Camel Catalog and Supporting Schemas
To build the Camel Catalog and the supporting schemas, run:
```sh
yarn workspace @kaoto/camel-catalog run build
```
_Optional: You can update the Camel version in the `pom.xml` file and then run the build command again._
## Storybook
To view the storybook stories, go to [Chromatic](https://main--64ef22df8bb709ffa98c7a47.chromatic.com/). 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](https://storybook.js.org/docs/react/writing-stories/introduction).
To run Storybook locally:
``` bash
# 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`
