BoldBI Embedding React with PHP Sample

This project was created using React with PHP. This application aims to demonstrate how to render the dashboard available on your Bold BI server.

Dashboard view

Prerequisites

The samples require the following requirements to run.

• PHP
• Node.js
• Visual Studio Code

NOTE: Node.js versions 18.17 to 20.14 are supported.

Supported browsers

• Google Chrome, Microsoft Edge, and Mozilla Firefox.

Configuration

• Please ensure you have enabled embed authentication on the embed settings page. If it is not currently enabled, please refer to the following image or detailed instructions to enable it.

  

• To download the embedConfig.json file, please follow this link for reference. Additionally, you can refer to the following image for visual guidance.

  

  

• Copy the downloaded embedConfig.json file and paste it into the designated location within the application. Please ensure you have placed it in the application, as shown in the following image.

  

Run a PHP Sample

• Open the PHP sample in visual studio code or any respective IDE.

• Ensure whether embedConfig file is located in following location, PHP/embedConfig.json and run the PHP application using the respective IDE or using visual studio code.

Run a Sample Using Command Line Interface

• Open the command line interface and navigate to the specified file location where the project is located.

• Run the back-end PHP sample using the following command php -S localhost:8080.

• Open the command line interface and navigate to the specified file location where the project is located.

• To install all dependent packages, use the following command npm install.

• Finally, run the application using the following command npm start. After executing the command, the application will automatically launch in the default browser. You can access it at the specified port number (e.g., https://localhost:3000).

Developer IDE

• Visual Studio Code

Run a Sample Using Visual Studio Code

• Open the PHP sample in Visual Studio Code.

• Run the PHP sample, use the below command

    php -S localhost:8080

• Open the React sample in Visual Studio Code.

• Install all dependent packages, use the below command

    npm install

• Run the React sample, use the below command

    npm start

• After executing the command, the application will automatically launch in the default browser. You can access it at the specified port number (e.g., https://localhost:3000).

  

NOTE: If the API host is already in use, modify the port number according to your preference and update it in the Dashboard.js file.

Online Demos

Look at the Bold BI Embedding sample to live demo here.

Documentation

A complete Bold BI Embedding documentation can be found on Bold BI Embedding Help.