commit | 0b28a10ae3c286015f532e37b4ec5ec76e20e3b4 | [log] [tgz] |
---|---|---|
author | Eder Ignatowicz <ignatowicz@gmail.com> | Fri Oct 06 10:48:49 2023 -0400 |
committer | GitHub <noreply@github.com> | Fri Oct 06 11:48:49 2023 -0300 |
tree | b82a622b1011dca277209be76a5ca488ba40f9ad | |
parent | d7d9c8f53e9525ad825d0910d5e1cb8b8e68b5d8 [diff] |
[0.32.0] KOGITO-9862: Manifest gen should not required a cluster connection (#2007)
The KIE Community is a home for leading Open Source projects that play a role in delivering solutions around Business Automation and Artificial Intelligence in the Cloud.
This repository contains tooling applications and libraries for KIE projects.
To start building the KIE Tools project, you're going to need:
18
(To install, follow these instructions: https://nodejs.org/en/download/package-manager/)8.7.0
(To install, follow these instructions: https://pnpm.io/installation)3.8.6
11
1.21.1
(To install, follow these instructions: https://go.dev/doc/install)ℹ️ NOTE: Some packages will require that
make
is available as well.
ℹ️ NOTE: *nix users will also need:
lib-gtk-3-dev
appindicator3-0.1
(libayatana-appindicator3-dev
orlibappindicator-gtk3-devel
andgir1.2-appindicator3-0.1
)
ℹ️ NOTE: Users of Fedora or RHEL will need to add a repository:
sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
After installing the tools above, you'll need to download the dependencies and link the packages locally. Simply run:
pnpm bootstrap
To install only the dependencies that are relevant to the package called [pkg-name]
.
pnpm bootstrap -F [pkg-name]...
⚠️ NOTE: Here,
...
is actually necessary! They're part of apnpm
filter.
After dependencies are installed, you‘ll be able to build. To do so, you’ll have two choices - dev
, or prod
.
Note that it is recommended that you specify which package you want to build, so replace [pkg-name]
with the name of the desired package on one of the commands below:
pnpm -F [pkg-name]... build:dev
- This is fast, but not as strict. It skips tests, linters, and some type checks. Be prepared for the CI to fail on your PRs.pnpm -F [pkg-name]... build:prod
- The default command to build production-ready packages. Use that to make sure your changes are correct.⚠️ NOTE: Here,
...
is actually necessary! They're part of apnpm
filter.
ℹ️ NOTE: If you want to build everything, run
pnpm -r build:dev
orpnpm -r build:prod
. It's going to take a while, though :)
ℹ️ NOTE: The KIE Tools build is parameterized by several Environment Variables. For an extensive list of these variables, please see the list printed by the
bootstrap
script.
ℹ️ NOTE: Final artifacts will be on
{packages,examples}/*/dist
directories.
The KIE Tools project contains several applications. To develop each one of them individually, refer to the instructions below.
packages/kie-editors-dev-vscode-extension
folder on VS Code. Use a new VS Code window so that the packages/kie-editors-dev-vscode-extension
folder shows up as root in the VS Code explorer.Debug
menu/section. You can also use the respective shortcuts (F5 to start debugging, for instance).webpack
and webpack-cli
to be globally installed on NPM. Normally you can do that with npm install -g webpack@^5.88.2 webpack-cli@^4.10.0
, but sudo
may be required depending on your installation.packages/kie-editors-dev-vscode-extension
, you have to manually rebuild them before relaunching the extension on VS Code.packages/serverless-workflow-vscode-extension
folder on VS Code. Use a new VS Code window so that the packages/serverless-workflow-vscode-extension
folder shows up as root in the VS Code explorer.Debug
menu/section. You can also use the respective shortcuts (F5 to start debugging, for instance).packages/serverless-workflow-vscode-extension
, you have to manually rebuild them before relaunching the extension on VS Code.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.pnpm build:dev
on packages/chrome-extension-pack-kogito-kie-editors
. This will create a version of the Chrome Extension that fetches the envelope locally.pnpm start
on packages/chrome-extension-pack-kogito-kie-editors
. This will start a webpack serve
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.chrome://flags/#allow-insecure-localhost
in your Chrome browser and enable this flag. Alternativelly, you can go to https://localhost:9001
and add an exception.chrome://extensions
. Enable “Developer mode” in the top-right corner and click on “Load unpacked”. Choose the packages/chrome-extension-pack-kogito-kie-editors/dist
folder.packages/chrome-extension-serverless-workflow-editor
folder on your favourite IDE. You can import the entire repo as well if you want to make changes to other packages.pnpm build:dev
on packages/chrome-extension-serverless-workflow-editor
. This will create a version of the Chrome Extension that fetches the envelope locally.pnpm start
on packages/chrome-extension-serverless-workflow-editor
. This will start a webpack serve
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.chrome://flags/#allow-insecure-localhost
in your Chrome browser and enable this flag. Alternativelly, you can go to https://localhost:9000
and add an exception.chrome://extensions
. Enable “Developer mode” in the top-right corner and click on “Load unpacked”. Choose the packages/chrome-extension-serverless-workflow-editor/dist
folder.packages/online-editor
.pnpm start
. This will start a webpack serve
instance with the Online Editor resources.https://localhost:9001
.pnpm start
at packages/cors-proxy
.packages/serverless-logic-web-tools
.pnpm start
. This will start a webpack serve
instance with the Serverless Logic Web Tools resources.https://localhost:9020
.pnpm start
at packages/cors-proxy
.packages/kie-editors-standalone
.pnpm start
. This will start a webpack serve
instance with the Standalone Editors test page.https://localhost:9001/resources/dmn
and the Standalone BPMN Editor by accessing https://localhost:9001/resources/bpmn
.The stunner-editors
package contains the BPMN, DMN, and SceSim Editors that are used in many applications of KIE Tools. After cloning the repo, start with a fresh build.
pnpm bootstrap -F @kie-tools/stunner-editors...
pnpm -F @kie-tools/stunner-editors... build:dev
After that, you're ready to start developing the Editors individually.
BPMN
packages/stunner-editors/kie-wb-common-stunner/kie-wb-common-stunner-sets/kie-wb-common-stunner-bpmn/kie-wb-common-stunner-bpmn-kogito-runtime
.mvn clean gwt:run
to start. To enable live-reloading capability, run mvn clean gwt:run -Phot-reload
DMN
packages/stunner-editors/kie-wb-common-dmn/kie-wb-common-dmn-webapp-kogito-runtime
.mvn clean gwt:run
to start. To enable live-reloading capability, run mvn clean gwt:run -Phot-reload
Test Scenario (SceSim)
packages/stunner-editors/drools-wb-screens/drools-wb-scenario-simulation-editor/drools-wb-scenario-simulation-editor-kogito-testing
.mvn clean gwt:run
to start.