@balena/jellyfish-plugin-default

Jellyfish Default Plugin

This plugin currently only provides the default set of cards necessary for normal operations.

Usage

Below is an example how to use this library:

import { defaultPlugin } from '@balena/jellyfish-plugin-default';
import { PluginManager } from '@balena/jellyfish-worker';

// Load contracts from this plugin
const pluginManager = new PluginManager([defaultPlugin()]);
const contracts = pluginManager.getCards();
console.dir(contracts);

Documentation

Visit the website for complete documentation: https://product-os.github.io/jellyfish-plugin-default

Testing

Unit tests can be easily run with the command npm test.

The integration tests require Postgres and Redis instances. The simplest way to run the tests locally is with docker-compose.

npm run test:compose

You can also run tests locally against Postgres and Redis instances running in docker-compose:

npm run compose
REDIS_HOST=localhost POSTGRES_HOST=localhost npx jest test/integration/actions/action-ping.spec.ts

You can also access these Postgres and Redis instances:

PGPASSWORD=docker psql -hlocalhost -Udocker
redis-cli -h localhost