0.0.0 • Published 4 years ago

@manstis/test v0.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 years ago

Kogito

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

GitHub Stars GitHub Forks GitHub Issues Pull Requests Contributors License Twitter Follow

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):

Releases

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

Build from source

  1. Check out the source:

    git clone git@github.com: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.
Desktop and Hub
  1. After you've successfully built the project following the instructions above, go to packages/desktop or packages/hub. They work exactly the same.
  2. To start the application in development mode, you can run yarn start. If you make changes and want to reload the app, run yarn run build:fasts && yarn start. This will recompile the module and restart the Electron app. Remember: if you make changes to other modules, you have to build them too!
  3. To build and package the application for production (i.e. generating an executable), you can run yarn run build:prod. This will pack the application for the current OS. If you want to pack the application for a different OS, run yarn run pack:linux, for example. See package.json for more details.

Contribute

  • When opening PRs, please make sure to provide a detailed description of the issue along with the JIRA, if there's one.
  • Also, since we depend on BPMN, DMN and Test Scenario editors and our CI build is not integrated with the editors, when you need an updated version of the editors to be used, please provide a VSIX bundle so people can at least test your changes easily on VSCode. Also, it's a good pratice to put a note on your PR saying that the editors have changed too.

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: