Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.86 KB

README.md

File metadata and controls

53 lines (30 loc) · 1.86 KB

Starter Components

Hello and welcome to our Embeddable components starter back built just for you by the Embeddable team ❤️ We wish to thank you for being one of the first to use the platform and welcome any feedback you might have.

Installation

npm i # requires node 18 or later

Build & Deploy

This is how you push code changes to your Embeddable workspace

npm run embeddable:login

npm run embeddable:build

npm run embeddable:push

open https://app.embeddable.com

Local Development

This is a "Preview workspace" (local to you) that allows you make changes locally and see them instantly without needing to "Build and Deploy".

npm run embeddable:login

npm run embeddable:dev # opens a "Preview" workspace, that uses your local components and models

Debugging Data Models

To test and debug your data models locally using Cube's data playground:

Create a .env file in the same folder as cube-playground.yml and follow the instructions here to add your database's credentials.

npm run cube:playground

open localhost:4000

In the playground you can:

  • query for measures and dimensions
  • see results
  • see generated SQL
  • set the Security Context to test row level security
  • test pre-aggregations

Official documentation on using Cube's playground can be found here.

Debugging Pre-aggregations

While cube playground is running, you can run npm run cube:cubestore to get access to a mysql interface on top of your locally stored preaggregations.

E.g. list the stored preaggregations using SELECT * FROM information_schema.tables;

Official documentation on inspecting local pre-aggregations can be found here.