Demos and Examples

Explore the demonstration instance of BitBroker

Here you will find information about a range of BitBroker demo applications and connectors to help you understand what BitBroker is and how it can operate in complex data sharing scenarios.

Most importantly, it will help you get started building your own applications which use BitBroker data or your own data connectors to contribute data into the system.

Our example’s repository includes support for deploying the example connectors and applications against a BitBroker deployment, via a set of supporting scripts. This can be via either Helm or Docker-Compose.

The example connectors are deployed supporting two example datasets: countries and heritage sites.

Demo Applications

We have a number of example applications, which allow users to explore policy based access to data via the Consumer API.

Data Explorer

This application allows you to explore the entire Consumer API by directly trying out a number of interactive scenarios. It has a set of example data and polices already pre-installed and running.

You can explore using the Catalog API to try different, complex catalog queries. You can see how the results of these queries differ in the light of different policies - which you can switch between simply in the application.

Once you have executed a query and obtain entity instance records, you can use the Entity API to browse the whole list and inspect the details of individual entities.

Finally, for country data, you can also see the Timeseries API in actions and integrated with a charting library.

All the source code for this demo is available in the examples repository of our GitHub.

Mapping Sample

This application allows you to explore the Consumer API via the medium of a mapping application. It has a set of example data and polices already pre-installed and running. The geographical attributes within the example data are used to populate a map view of the data records.

You can explore how the application outputs are changed in the light of different policies - which you can switch between simply in the application.

All the source code for this demo is available in the examples repository of our GitHub.

Demo Data Connectors

Here we provide a range of data connectors to help you understand what they are and how to build your own. Indeed, it is hoped that you can simply modify one of these data connectors to achieve your own data submission aims.

We will endeavor to increase the example data connectors here over time. Offering more choices of both data sources and implementation languages. We welcome help from the community on this and you are encouraged to submit your own data connectors in the sample set.

We currently have two types of example connector:

File based - dataset loaded directly from a file
RDBMS - data drawn from a relational database

All implementations upload data to the BitBroker catalog. They also fetch and return third-party data in their entity webhooks for the example country dataset, and both support time series data for the country dataset.

All the source code for these connectors is available in the examples repository of our GitHub.

NodeJS » File Based

This example connector is implemented in NodeJS and uses a simple file as its source data store. Key characteristics of this connector are:

Initial dataset loaded from a file over HTTP
Supports for a range of file types: JSON, Microsoft Excel, CSV, etc
Implements catalog updating via sessions
Implements all webhook end-points

NodeJS » RDBMS

This example connector is implemented in NodeJS and uses a PostgreSQL database as its source data store. Key characteristics of this connector are:

Initial dataset loaded via SQL calls on a relational database
Implements catalog updating via sessions
Implements all webhook end-points