From ba328afc114476cb45fea7286a5811e9b822b5ff Mon Sep 17 00:00:00 2001 From: Roman Acevedo Date: Wed, 12 Mar 2025 17:41:38 +0100 Subject: [PATCH] chore: add useful dev commands doc --- Dockerfile | 3 +++ README.md | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..51fdc04c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,3 @@ +# for dev purposes only +FROM kestra/kestra:latest +COPY build/libs/* /app/plugins/ \ No newline at end of file diff --git a/README.md b/README.md index 3a86780f..a522c86c 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,24 @@ This repository serves as a general template for creating a new [Kestra](https:/ ![Kestra orchestrator](https://kestra.io/video.gif) +## Running the project in local +### Prerequisites +- Java 21 +- Docker + +### Running tests +``` +./gradlew check --parallel +``` + +### Launching the whole app +``` +./gradlew shadowJar && docker build -t kestra-custom . && docker run --rm -p 8080:8080 kestra-custom server local +``` +> [!NOTE] +> You need to relaunch this whole command everytime you make a change to your plugin + +go to http://localhost:8080, your plugin will be available to use ## Documentation * Full documentation can be found under: [kestra.io/docs](https://kestra.io/docs)