Skip to content

Incorta/component-sdk

Repository files navigation

Incorta Component SDK

The Incorta Component SDK is used to create new visualizations or plugins for Incorta Analyzer and Dashboards.

Development of Incorta Components presumes knowledge of HTML, CSS, JSON, Javascript, Node.js, NPM, React, and Typescript. You will also need to be familiar with Incorta, including Incorta Analyzer, and analytics concepts in general.

Note: This project contains the Typescript definition and JSON schema files for an Incorta Component SDK project. The actual project that developers will use is incorta/create-incorta-component installable via NPM.

Prerequisites

  • You'll need access to an Incorta cluster. Incorta Cloud signup is quick and easy.
  • A code editor. Even if you have another favorite editor, we recommend Visual Studio Code so that you can take advantage of the auto-complete in the configuration JSON files.
  • Node.js in order to get NPM (Node Package Manager)

Install the Incorta component package

This lets you create new Incorta components and run the testing server.

% npm install -g @incorta-org/create-incorta-component

To Create a new Incorta Component

% create-incorta-component new