srambach / kogito-tooling

Tooling for Kogito http://kogito.kie.org

Kogito

Kogito is the next generation of business automation platform focused on cloud-native development, deployment and execution.

Quick Links

Homepage: http://kogito.kie.org

Wiki: https://github.com/kiegroup/kogito-tooling/wiki

JIRA: https://issues.jboss.org/projects/KOGITO

jBPM: https://www.jbpm.org/

Drools: https://www.drools.org/

Getting Started

This module contains a number of examples that you can take a look at and try out yourself. Please take a look at the readme of each individual example for more details on how the example works and how to run it yourself (either locally or on Kubernetes):

• jBPM + Quarkus Hello World: README.md
• jBPM + Quarkus: README.md
• jBPM + Spring Boot: README.md
• jBPM + Drools + Quarkus: README.md - Onboarding example combining one process and two decision services
• Polyglot Drools with GraalVM: README.md
• Drools + Quarkus: README.md
• Drools + Quarkus with Unit: README.md

Releases

In Kogito Tooling releases page you will find extensions and released tooling packages.

Build from source

1. Check out the source:

   git clone [email protected]:kiegroup/kogito-tooling.git
   

   If you don't have a GitHub account use this command instead:

   git clone https://github.com/kiegroup/kogito-tooling.git
   

2. Build with Yarn:

   cd kogito-tooling
   yarn run init
   
   #prod
   yarn run build:prod
   
   # dev
   yarn run build # skips integration tests and production packing
   yarn run build:fast # skips lint and unit tests

   NOTE: It's necessary to have the Git tags fetched when building with build:prod.

   Final artifacts will be on packages/*/dist directories.

Develop

NOTE: We recommend using LTS version of Node.js when developing this project.

VSCode Extension

1. After you've successfully built the project following the instructions above, open the packages/vscode-extension-pack-kogito-kie-editors folder on VSCode. Use a new VSCode window so that the packages/vscode-extension-pack-kogito-kie-editors folder shows up as root in the VSCode explorer.
2. From there, you can Run the extension or the integration tests by using the Debug menu/section. You can also use the respective shortcuts (F5 to start debugging, for instance).
3. Remember! If you make changes to packages other than packages/vscode-extension-pack-kogito-kie-editors, you have to manually rebuild them before relaunching the extension on VSCode.

Chrome Extension

1. After you've successfully built the project following the instructions above, open the packages/chrome-extension-pack-kogito-kie-editors folder on your favourite IDE. You can import the entire repo as well if you want to make changes to other packages.
2. Open a terminal and run yarn run serve-envelope on packages/chrome-extension-pack-kogito-kie-editors. This will start a webpack-dev-server instance with the editors and their envelope. We use that because we don't pack the Chrome Extension bundle with the editors inside. Instead, we fetch them from GitHub pages.
3. Open Chrome and go to chrome://extensions. Enable "Developer mode" on the top right corner and click on "Load unpacked". Choose the packages/chrome-extension-pack-kogito-kie-editors/dist folder.
4. From now on you can use the development version of the extension. Remember! After each change, you have to rebuild the changed modules and hit the "Refresh" button of the extension card.

Online Editor

1. After you've successfully built the project following the instructions above, open the packages/chrome-extension-pack-kogito-kie-editors folder on your favourite IDE. You can import the entire repo as well if you want to make changes to other packages.
2. Open a terminal and run yarn run serve-envelope on packages/chrome-extension-pack-kogito-kie-editors. This will start a webpack-dev-server instance with the editors and their envelope. We use that because we don't pack the Online Editor bundle with the editors inside. Instead, we fetch them from GitHub pages.
3. Open a terminal and run yarn start on packages/online-editor. This will start a webpack-dev-server instance with the Online Editor resources.
4. You also have to enable invalid certificates for resources loaded from localhost in your browser. To do that, go to chrome://flags/#allow-insecure-localhost in your Chrome browser and enable this flag.
5. From now on you can use the development version of the Online Editor by accessing https://localhost:9001.

Contributing to Kogito

All contributions are welcome! Before you start please read the Developing Drools and jBPM guide.

Guides

Here are some of the most notable ones for quick reference:

• Quarkus - Using Kogito to add business automation capabilities to an application - This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules.
• Quarkus - Getting Started - Quarkus Getting Started guide