@flowbuild/diagrams-core

diagrams-core

diagrams-core is a BPMN diagrams manager for your project.

Installation

Run the following command in your terminal:

npm install @flowbuild/diagrams-core

Usage

const { DiagramCore } = require('@flowbuild/diagrams-core');
const diagramCore = new DiagramCore(db);

// note that 'db' has to be a database configuration

The service does have a blueprint storage, but it only stores the data relevant to the diagram, a.k.a. nodes and lanes (prepare, environment and parameters are discarded).

Environment variables

Add a .env file with the following variables:

• KNEX_ENV (suggested value = docker)
• NODE_ENV (suggested value = docker)
• POSTGRES_USER (default = postgres)
• POSTGRES_PASSWORD (default = postgres)
• POSTGRES_DB (default = diagrams)
• POSTGRES_HOST (default = localhost)
• POSTGRES_PORT (default = 5432)
• LOG_LEVEL (default = info)

Testing on Docker:

Use the following command in order to setup two containers (database and test servers) and run migrations, seeds and tests.

docker-compose up