Component SDK → Getting Started
To get started with your Component SDK, you must first complete the following steps:
- Download a code editor to use in the development phase.Recommendation
If you do not have a preferred code editor, we recommend using Visual Studio Code to benefit from the auto-complete feature while configuring the JSON files.
- Install HomeBrew.Note
HomeBrew is a package manager and it is highly recommended for future installations.
- Install Node.js :
% brew install node
- Install Node Package Manager (NPM):
% brew install npm
After completing all of the prerequisites, download the component SDK to your local machine where all of the development process will take place, and then start the Component SDK.
From your command line interface (CLI), run the following commands in order:
Download the Component SDK:
% npm install -g @incorta-org/create-incorta-component
Change the directory to your development environment, for example:
Start the SDK:
create-incorta-component command has more than one possible attribute value:
|Creates the scaffolding for a new Incorta Component, where |
|Start the development server to connect with your Incorta cluster to begin implementing your visualization. |
|Build the visualization you developed and generate the |
|Display the help description for a certain command, where |
After starting the Component SDK, create a new project using the following command:
create-incorta-component new <directory_name>