A quick overview of a sample Node.js server

We have prepared a sample Node.js server that implements the custom data source API. It is available on our GitHub.

To run our sample Node.js server, complete the following steps.

Step 1. Download the sample Node.js server

Step 1.1. To get our sample project, download it as ZIP or clone it with the following command:

git clone https://github.com/flexmonster/api-data-source

Step 1.2. The sample Node.js server is available in the server-nodejs/ folder. Navigate to this folder:

cd api-data-source/server-nodejs

Step 2. Install npm dependencies

Install the npm dependencies described in the package.json file:

npm install

Step 3. Run the sample Node.js server

To start the server, run the following commands in a console:

npm start

All requests from Flexmonster Pivot are handled by the http://localhost:3400/api/cube endpoint.

Raw data is stored in JSON format in the server-nodejs/data/ folder.

Step 4. Configure the report

On the client side (e.g., /client/index.html), the report should be configured as follows:

new Flexmonster({
  container: "pivotContainer",
  report: {
    dataSource: {
      type: "api",
      url: "http://localhost:3400/api/cube",
      index: "fm-product-sales"
    }
  }
});

The dataSource.index property must match the name of the JSON file from the server-nodejs/data/ folder.

To see Flexmonster with the data from the sample Node.js server, open the client/index.html file in a browser.

See also

• Implementing the custom data source API on your server
• Configuring filters
• Configuring aggregation functions
• A quick overview of a sample .NET Core server