For developers

Build on SyncBridge. Publish on the Marketplace.

Write apps and the components they are built from in TypeScript, test them like any package, and publish them - publicly, or to your organization alone.

Your first packageBrowse the Marketplace

What you can build

An extension package carries any of three kinds; SyncBridge finds them in its manifest.

Apps

The apps a worker runs: a service, an integration, a scheduled job. Configured by their users in a form, each in a process of its own.

Components

The building blocks apps are made of: connections, protocols, transformers - HL7, Kafka, a serial port, a database.

Plugins

Extensions of the server itself, written against @syncbridge/plugin-api and loaded into the server's main process.

Your first package in minutes

Node.js and npm are all it takes.

  1. 1

    Start a package

    Install spm, the toolchain’s CLI, once; it starts the package: its package.json and manifest, TypeScript and test setup, an example app and its first test.

    $
    npm install -g @syncbridge/syncbuild
spm init @acme/patient-monitor
cd patient-monitor && npm install
  2. 2

    Test it

    Apps run in a test environment of their own, as a worker runs them (@syncbridge/testing).

    $
    npm test
  3. 3

    Check and pack it

    spm verifies the package as SyncBridge will load it, and packs it into the archive you publish.

    $
    spm verify
spm pack

The toolchain

Open npm packages, versioned with SyncBridge.

@syncbridge/syncbuildspm: starts, builds, checks, verifies and packs a package; adds the packages it uses.@syncbridge/commonWhat apps and components are written with: their base classes, settings, logging.@syncbridge/plugin-apiThe API plugins are written against.@syncbridge/testingA test environment that runs an app as a worker would.@syncbridge/runtimeInstalls packages and runs apps in workers, as SyncBridge does: for trying a package outside a server.

Build on published components

Add the Marketplace’s public or commercial components as dependencies, and build your own apps and components on them. spm adds them; their TypeScript types come along, without their source.

$
spm add @acme/hl7@^1.2.0

Full types, closed code

What you install is the package's type declarations: autocompletion and type checks as with any package, while its code stays with its publisher.

Declared once

spm add writes the dependency into the manifest and the TypeScript paths; SyncBridge installs it with your package on the server.

Publish

Packages are published under an organization, from SyncBridge Console.

  1. 1

    Create your organization

    Its short name is your packages' scope: @acme/...

  2. 2

    Give the rights

    Who may create packages, and who may publish new versions of each.

  3. 3

    Upload the package

    The archive spm pack made, public or private.

  4. 4

    Share it

    A public package is on the Marketplace for everyone; a private one for your organization and those you grant it.

Commercial packages - sold on the Marketplace - are coming soon.

Where to go next

SyncBridge ConsoleYour organizations, packages and publishers.MarketplaceThe apps and components published so far.The packages on npmThe toolchain, its documentation in each README.