Skip to content

Commit

Permalink
Cleanup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mgubaidullin committed Jul 5, 2023
1 parent df02470 commit 2ffe150
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 34 deletions.
47 changes: 15 additions & 32 deletions DEV.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,37 @@
## Project structure
1. Karavan-generator
Generate Camel Models and Api from Camel sources to Typescript in Karavan-designer
2. Karavan-Designer
KaravanDesigner UI component and simple web app
3. Karavan-vscode
VS Code extension based on KaravanDesigner
Generate Camel Models and Api from Camel sources to Typescript in karavan-core
2. Karavan-core
Front-end Camel Models and Api
3. Karavan-Designer
KaravanDesigner UI component
4. Karavan-app
Karavan Application
5. Karavan-demo
Demo of Karavan use cases

Karavan Cloud Application
5. Karavan-vscode
VS Code extension based on Karavan Designer

## How to build
1. Generate Camel Models and API for Typescript
```
cd karavan-generator
mvn clean compile exec:java -Dexec.mainClass="org.apache.camel.karavan.generator.KaravanGenerator" -f karavan-generator
```

2. Build VS Code extension
2. Install Karavan core library
```
cd karavan-vscode
yarn install
yarn run compile // dev
yarn run package //prod
cd karavan-core
npm install
```

3. Build Karavan app
- Build JVM Mode
```
cd karavan-app
mvn clean package -Dquarkus.container-image.build=true
```
- Build native
```
DOCKER_BUILDKIT=1 docker build -f karavan-app/src/main/docker/Dockerfile.multistage -t apache/camel-karavan .
mvn clean package -Dquarkus.profile=public
```

## Development Karavan app
You can run your application in dev mode that enables live coding using:
- Backend
```shell script
cd karavan-app
mvn quarkus:dev
```
- Frontend
```shell script
cd karavan-core/
npm install

cd karavan-app/src/main/webui/
npm install
npm start
```
mvn quarkus:dev -Dquarkus.profile=public
```
7 changes: 5 additions & 2 deletions karavan-vscode/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Changelog

## 3.20.2
## 3.21.0
0. Camel 3.21.0
1. Spring Boot 2.7.13
1. Kamelets 3.21.0
2. Spring Boot 2.7.13
3. jkube 1.13.1 d
4. Quarkus 2.16.7.Final

## 3.20.1
0. Camel 3.20.3
Expand Down

0 comments on commit 2ffe150

Please sign in to comment.