run-camunda
Download, spin up and shutdown the Camunda Platform painlessly from Node.
Usage
Install run-camunda globally or as a local dev dependency:
npm install -g run-camundaUse the provided camunda command to start and stop Camunda:
$ camunda start
Downloading Camunda v7.22...
Starting Camunda.....
Camunda started.
$ camunda stop
Stopping Camunda...
Cleaning up...
Camunda stopped.Run Directly
You may run the utility directly without prior installation via npx:
$ npx run-camunda start
Downloading Camunda v7.22...
Starting Camunda.....
Camunda started.Use via API
import {
startCamunda,
stopCamunda,
isCamundaRunning
} from 'run-camunda';
await startCamunda();
await isCamundaRunning();
await stopCamunda();Choose Camunda Version
You may define the CAMUNDA_VERSION environment variable to decide which version to download:
set CAMUNDA_VERSION=7.13
camunda startAccess Camunda
Camunda is up and running on http://localhost:8080 once camunda start completes.
REST API
Access the Camunda instance via the Camunda REST API, available at http://localhost:8080/engine-rest.
Refer to the Camunda documentation to learn how to deploy and run your processes. Checkout camunda-worker-node for a simple way to contribute work via external tasks.
Webapps
The running Camunda instance includes all stock apps:
| App | Purpose |
|---|---|
| Admin | administrate engines, users and rights |
| Cockpit | introspect the engine |
| Tasklist | list and execute tasks |
| Welcome | check your user profile |
The default login for these apps is demo:demo.
Test Life-Cycle Integration
Use pretest and posttest hooks in your project's package.json to integrate run-camunda into the test life-cycle:
{
"scripts": {
"pretest": "camunda start",
"test": "echo 'running test'",
"posttest": "camunda stop"
}
}Related
Resources
Projects
License
MIT