kaoto
kaoto copied to clipboard
Next version of the UI of the Kaoto project
kaoto
The next version of the UI for the Kaoto project.
https://kaotoio.github.io/kaoto/
Table of Contents
- Requirements
-
Getting Started
- Clone the Repository
- Install Dependencies
- Running kaoto with Docker
-
Development
-
Web Application
- Run
- Build
- Public Components
-
Web Application
- How to do a release
- Camel Catalog and Supporting Schemas
- Storybook
Requirements
For more information on Vite, check Vite's documentation.
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
Camel Catalog and Supporting Schemas
To build the Camel Catalog and the supporting schemas, run:
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. 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