Developers

This section of the DataHub documentation is for developers. Here you can learn about the design of the platform and how to get DataHub running locally or on your own servers, and the process for contributing enhancements and bug fixes to the code.

(opens new window)

Internal docs

• API
• Deploy
• Platform
• Publish
• User Stories
• Views Research
• Views

Repositories

We use following GitHub repositories for DataHub platform:

• DEPLOY (opens new window) - Automated deployment

• FRONTEND (opens new window) - Frontend application in node.js

• ASSEMBLER (opens new window) - Data assembly line

• AUTH (opens new window) - A generic OAuth2 authentication service and user permission manager.

• SPECSTORE (opens new window) - API server for managing a Source Spec Registry

• BITSTORE (opens new window) - A microservice for storing blobs i.e. files.

• RESOLVER (opens new window) - A microservice for resolving datapackage URLs into more human readable ones

• DOCS (opens new window) - Documentations

Install

We use several different services to run our platform, please follow the installation instructions here:

• Install Assembler (opens new window)

• Install Auth (opens new window)

• Install Specstore (opens new window)

• Install Bitstore (opens new window)

• Install DataHub-CLI (opens new window)

• Install Resolver (opens new window)

Deploy

For deployment of the application in a production environment, please see the deploy page (opens new window).

DataHub CLI

The DataHub CLI is a Node JS lib and command line interface to interact with an DataHub instance.

CLI code (opens new window)