/zeebetron

small UI for zeebe control

Primary LanguageTypeScriptMIT LicenseMIT

zeebetron

GitHub repo size GitHub contributors GitHub stars GitHub forks Twitter Follow

zeebetron is a small frontend to manage different profiles for zeebe instances (cloud or local).

gif

Usually I use zbctl or my own small starter project to interact with zeebe. But since I had a lot of zeebe instances and I was switching between them, I wanted to build a small tool to manage profiles.

The added value of zeebetron is

  • Manage different profiles including addresses and if necessary oAuth information
  • Manage different workflows for deploying or creating new instances

The tool itself is built with Electron and Angular. The communication with zeebe is done via zeebe-node, the rendering of BPMN diagrams is done using bpmn-js.

Releases

Find all releases here.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed node.

That's it ;) Admittedly, I didn't test the project on Windows, but it runs fine on Ubuntu and Mac.

Development

Install all dependencies with

npm install

Run the development version of the app including hot reload:

npm run start

Build a release:

npm run electron:linux # (or mac or windows)

Contributing to zeebetron

To contribute to zeebetron, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Create the pull request to this project.

Alternatively see the GitHub documentation on creating a pull request.

Contact

If you want to contact me you can reach me at adam.urban@gmail.com.

License

This project uses the following license: MIT.