metabase/shoppy

Shoppy: Embedding SDK demo application

Shoppy is a demo application that showcases the capabilities of Metabase's React Embedding SDK. It is a simple e-commerce dashboard that allows shop owers to view and analyze sales data.

The demo is available at https://embedded-analytics-sdk-demo.metabase.com.

How to run the demo on your machine

This demo uses the data from the hosted Metabase Cloud instance and provides a hosted JWT server, therefore you do not need to run the Metabase server and JWT server locally.

• Create local environment files.

  • cp .env.example .env

• Install the required dependencies.

  • yarn

• Run the React frontend.

  • yarn dev

• Disable CORS in your browser. You can find how to do it here https://medium.com/@beligh.hamdi/run-chrome-browser-without-cors-872747142c61; also you can use a browser extension.

• Visit http://localhost:3004 in your browser.

How to develop the SDK locally?

[!IMPORTANT]
The following sections are for Metabase employees who are working on the embedding SDK. If you are not a Metabase employee, you can skip the following sections.

Using Docker

• Clone .env.docker.example to .env.docker and set the proper PREMIUM_EMBEDDING_TOKEN value.
• Run Docker via yarn docker:up for the production build or WATCH=true yarn docker:up for the development build with the watch support.
  • The command launches containers with the local MB instance, Shoppy DWH, Shoppy API and Shoppy Client.
  • Visit http://localhost:4400.
• To stop containers run yarn docker:down.
• To remove containers and images completely run yarn docker:rm.

Local development (For Metabase developers)

For a local development the App DB dump of the Shoppy's Metabase Instance must be downloaded.

See the Getting the App DB dump section.

• To run containers with a locally built metabase.jar, copy it to the ./local-dist folder as ./local-dist/metabase.jar.
• To run containers with a locally built Embedding SDK package, copy it to the ./local-dist folder as ./local-dist/embedding-sdk.
• Run yarn docker:local-dist:up to start containers and use locally built dist from the ./local-dist folder.
• To remove containers and images completely run yarn docker:rm.

Using an existing running MB instance

• Place the metabase repository in ../metabase

• Open a new terminal and run yarn build-release:cljs && yarn build-embedding-sdk:watch in the metabase repository. This watches for changes and builds the embedding SDK in development mode.

• Re-run the following command every time you make changes to the embedding SDK's source. This re-links the built SDK to the demo application.

  • yarn dev:link && yarn dev

How to run the demo against a local JWT auth server?

If you cannot use the hosted JWT server, you can run the JWT server locally.

• Update the API server's environment variables in api/.env. If you are a Metabase employee, refer to the "Shoppy - Environment File" item on the 1Password vault.

• Run the API server.

  • cd api && yarn && yarn dev

• Run the React frontend.

  • yarn dev:link && yarn dev

Running e2e tests (For Metabase developers)

To run e2e tests locally, the App DB dump of the Shoppy's Metabase Instance must be downloaded.

See the Getting the App DB dump section.

Then run yarn docker:e2e:up to start all required containers. After containers are up, run cd e2e && yarn cypress:open to run Cypress. To stop containers run yarn docker:rm.

Getting the App DB dump of the Shoppy's Metabase Instance

For a local development or for running e2e locally an App DB dump of the Shoppy's Metabase Instance must be placed to the ./metabase/metabase_dump.sql

You can get it by:

• Enabling the Tailscale and logging in using your work email address.
• Running pg_dump "postgres://{{ username }}:{{ password }}@{{ host }}:{{ port }}/{{ database }}" > ./metabase/metabase_dump.sql command.
  • See the Shoppy Coredev Appdb record in 1password for credentials.