Installation

Install the Metabase Embedding SDK in your React application

The Metabase Embedding SDK is available as an npm package that you can install using your preferred package manager.

Prerequisites

Before installing the SDK, make sure you have:

• Node.js 16 or higher
• React 18 or higher
• A Metabase instance (Pro or Enterprise plan)

Installing the SDK

npm

npm install @metabase/embedding-sdk-react

Setting up Metabase

If you don’t have a Metabase instance yet, you can:

Option 1: Start a free trial

Start a free trial of Metabase Pro or Enterprise.

Option 2: Run locally with Docker

Run Metabase Enterprise locally using Docker:

docker run -d -p 3000:3000 --name metabase metabase/metabase-enterprise:latest

Option 3: Download the JAR

Download and run the Metabase Enterprise JAR:

java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar

By default, Metabase will run at http://localhost:3000.

For more installation options, see the Metabase installation docs.

Next steps

Once you’ve installed the SDK, you can:

• Follow the quickstart guide to embed your first component
• Learn about authentication configuration
• Set up the MetabaseProvider in your app