https://github.com/bz-cli/bz-cli

Develop custom connectors for Bizagi Studio blazingly fast. With bz-cli you are now able to develop without the connector editor from Bizagi. 🚀
https://github.com/bz-cli/bz-cli

bizagi bizagi-connector bizagi-studio custom-connector

Last synced: about 1 month ago
JSON representation

Develop custom connectors for Bizagi Studio blazingly fast. With bz-cli you are now able to develop without the connector editor from Bizagi. 🚀

• Host: GitHub
• URL: https://github.com/bz-cli/bz-cli
• Owner: bz-cli
• License: mit
• Created: 2017-12-10T00:41:05.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-01T13:22:03.000Z (almost 7 years ago)
• Last Synced: 2024-10-05T11:17:15.805Z (2 months ago)
• Topics: bizagi, bizagi-connector, bizagi-studio, custom-connector
• Language: JavaScript
• Homepage:
• Size: 151 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - bz-cli - Develop custom connectors for Bizagi Studio blazingly fast. With bz-cli you are now able to develop without the connector editor from Bizagi. 🚀 (JavaScript)

README

        
# bz-cli

Develop custom connectors for Bizagi Studio blazingly fast. With bz-cli you are now able to develop wihtout the connector editor developed by Bizagi.

## Installation

~~~

npm install bz-cli

~~~

## Create a new project

~~~~

bz new 

~~~~

This will generate a new project with the following configuration:

### Template Stack

* [Babel](https://babeljs.io/) for transpilation.

* [jest](https://facebook.github.io/jest/) for testing.

* [bz-define](https://www.npmjs.com/package/bz-define) to create the bizagi custom connector definition.

* [bz-zip](https://www.npmjs.com/package/bz-zip) to bundle the connector to a .bizc file.

## Template Instructions ##

* Write your custom connector's actions in the `src` folder and transpile them with `npm run dev` and put them in `build/actions` for you.

* Write your tests in the `__tests__` folder. Run them with `npm test` or `npm t`.

* Build your connector with `npm run build`. A `Connector.bizc` file will be created as a result.

## Adding Actions

To create a connector aciton use

~~~

bz generate-action 

~~~

The action file will be kebab-cased and located in the src folder of your project.