type-casting-tool v6.14.12
BoldBI Embedded SDK
This project includes the Embedded SDK, which can be installed in web apps like Angular and React as an NPM package.
Prerequisites
The project requires the following items to run.
- Node.js - Above version 9.11.1
- Visual Studio Code
Steps to run the embed SDK project
To embed the dashboard in view or edit mode in an Angular or React application, we use this embed SDK as an NPM package. If the embed SDK need to be modify or improved, we can use this repository. The actions that must be taken are outlined below.
Pull the source code in your machine.
Use the command below to install the dependent packages and make your project runnable.
npm installIf you want to make any changes in source, make changes in
index.tsfile otherwise, you can skip this step.
Before running the typescript command, ensure that typescript is installed on your machine. If it is, you can verify it by running the below command to check the typescript version.
tsc -vIf typescript is not installed, please run this command to install it.
npm install -g typescriptRun the below command to convert the TS file to a JS file.
tsc
Steps to use the compiled Embedded SDK source with Angular application
You can use this as an local NPM package in the Angular Sample to embed a dashboard You can check out the Angular sample from here.
Using the Angular with ASP.NET Core sample
Pull the
angularsample here in your machine.Use the command below to install the dependent packages and make your project runnable.
npm installIf Angular CLI 14 is already installed on your machine, you can verify it by executing the following command to check the Angular version. Otherwise, you must install it to start the Angular application.
ng --versionIf angular CLI 14 is not installed, please run this command to install it on your machine.
npm i @angular/cli@14.0.6Follow the steps to configure the Embed details in both Backend(ASP.NET core) and Frontend (Angular).
To install the Bold BI Embedded SDK package, use the following command from the pulled location of the
BoldBI-SDKrepository.npm install {src directory}\boldbi-sdk Example of my pulled location: D:\sdkrepository\boldbi-sdkAfter installing the NPM package, check the node_modules folder in that
@boldbifolder will be created, which contains your local embed SDK.To run the angular sample, use the below command.
npm start
NOTE: You can also run the react sample by using this Embed SDK as NPM package refer and get the sample here.