Skip to content

Commit 2f743d3

Browse files
Readme update (#15)
* update readme * bump version for 52
1 parent 02ab060 commit 2f743d3

File tree

4 files changed

+36
-473
lines changed

4 files changed

+36
-473
lines changed

.env.example

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ VITE_AUTH_PROVIDER_URI="http://localhost:9090/sso/metabase"
66
# BACKEND
77
BACKEND_PORT=9090
88
METABASE_INSTANCE_URL= "http://localhost:3000"
9-
METABASE_JWT_SHARED_SECRET="XXX"
9+
METABASE_JWT_SHARED_SECRET="TODO"

README.md

+4-84
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,10 @@
1-
# Metabase embedding SDK for React sample application
1+
# Sample React application for Metabase's Embedded analytics SDK
22

3-
You'll need a Pro or Enterprise version of Metabase 52 up and running. If you're not sure where to start, sign up for [Pro Cloud](https://www.metabase.com/pricing).
3+
A quick app to kick the tires on the [Embedded analytics SDK](https://www.metabase.com/docs/latest/embedding/sdk/introduction).
44

5-
> [!IMPORTANT]
6-
> The SDK is compatible with Metabase v1.51 or higher
5+
## Quickstart
76

8-
## Create `.env` file
9-
10-
```sh
11-
cp .env.example .env
12-
```
13-
14-
## Adjust URLs
15-
16-
In `.env`, make sure your `VITE_METABASE_INSTANCE_URL` and `METABASE_INSTANCE_URL` point to your Metabase instance URL, e.g. `http://localhost:3000`.
17-
18-
## Set up your Metabase
19-
20-
- [Run Metabase Pro on a Cloud plan (with a free trial)](https://www.metabase.com/pricing)
21-
- Run Metabase Enterprise Edition locally. This sample app is compatible with [Metabase version v1.50 or higher](https://www.metabase.com/docs/latest/releases). When running locally, you'll need to [activate your license](https://www.metabase.com/docs/latest/paid-features/activating-the-enterprise-edition) to enable SSO with JWT.
22-
23-
### Enable SSO with JWT
24-
25-
From any Metabase page, click on the **gear** icon in the upper right and select **Admin Settings** > **Settings** > **Authentication**.
26-
27-
On the card that says **JWT**, click the **Setup** button.
28-
29-
### JWT identity provider URI
30-
31-
In the **JWT IDENTITY PROVIDER URI** field, paste `localhost:9090/sso/metabase` (or substitute your Cloud URL for localhost).
32-
33-
In your `.env` this address is set as:
34-
35-
```
36-
VITE_AUTH_PROVIDER_URI="http://localhost:9090/sso/metabase"
37-
```
38-
39-
### String used by the JWT signing key
40-
41-
Click the **Generate key** button. Copy the key and paste it in your `.env` file into the env var `METABASE_JWT_SHARED_SECRET`.
42-
43-
## Running the server
44-
45-
Change into the `server` directory:
46-
47-
```sh
48-
cd server
49-
```
50-
51-
Install packages:
52-
53-
```sh
54-
npm install
55-
```
56-
57-
Start the server:
58-
59-
```sh
60-
npm start
61-
```
62-
63-
## Start the client
64-
65-
In a different terminal, change into the `client` directory:
66-
67-
```sh
68-
cd client
69-
```
70-
71-
Install dependencies:
72-
73-
```sh
74-
npm install
75-
```
76-
77-
Start the client app:
78-
79-
```sh
80-
npm start
81-
```
82-
83-
Your browser should automatically open the app. By default, the app runs on [http://localhost:3100](localhost:3100).
84-
85-
## Set up groups and data sandboxing
86-
87-
To set up interactive embedding with JWT and data sandboxing, check out our [quick start guide](https://www.metabase.com/learn/customer-facing-analytics/interactive-embedding-quick-start).
7+
For getting up and running, see the [Quickstart with sample app](https://www.metabase.com/docs/latest/embedding/sdk/quickstart-with-sample-app).
888

899
## Reporting issues
9010

0 commit comments

Comments
 (0)