Kogito Apps

Contributing to Kogito

All contributions are welcome! Before you start please read the contribution guide.

Building from source

• Check out the source:

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

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

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

• Install Node and NPM package manager

See detailed instructions here for your OS.

• Install Yarn

cd kogito-apps/ui-packages
npm install -D yarn

• Install projects dependencies using Yarn

cd kogito-apps/ui-packages
yarn install

• Build with Yarn:

cd kogito-apps/ui-packages
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

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

Management Console

For detailed instructions on how to develop and run the Management Console, please check instructions on the specific README file.

ui-packages dependencies

ui-packages are managed with Yarn Workspaces and Lerna. Dependencies shared between packages are listed in the top-level package.json.

A locktt npm script relying on lock-treatment-tool is available to allow the usage of a private npm registry during building.

locktt replaces the host from ui-packages/yarn.lock resolved field with the custom registry. It is set to run just before the execution of yarn install. See ui-packages/pom.xml for further details.

Skipping frontend build

To skip the frontend build when running maven, simply execute Maven with the following parameters

mvn clean install -Dskip.ui.build -Dskip.ui.deps

Getting Help

Issues

• Do you have a minimal, reproducible example for your issue?
  • If so, please open a Jira for it in the Kogito project with the details of your issue and example.
• Are you encountering an issue but unsure of what is going on?
  • Start a new conversation in the Kogito Google Group, or open a new thread in the Kogito stream of the KIE Zulip chat.
  • Please provide as much relevant information as you can as to what could be causing the issue, and our developers will help you figure out what's going wrong.

Requests

• Do you have a feature/enhancement request?
  • Please open a new thread in the Kogito stream of the KIE Zulip chat to start a discussion there.