Getting started
0: Quick start guide

Quick start guide

If you’re reading this, it means you have early access to Embeddable (opens in a new tab).

This step-by-step guide walks you through the core concepts of Embeddable in just 20-30 minutes, helping you understand how it works while getting hands-on experience.

🟠 Required 🟢 Recommended 🔵 Optional

Build your first dashboard

  1. Download our git starter repository (where you customise your data models, components, themes and other workspace configuration) 🟠
  2. Set up your workspace (where all your Embeddable dashboards live) 🟠
  3. Build your first Embeddable (your first interactive dashboard using our test data) 🟢

Customise your dashboard components

  1. Build your own React.js component (for use on your dashboards) 🔵
  2. Import our Starter Components into your workspace (lots of charts and controls for you to play with) 🟢
  3. Theme your components (change fonts, colors, and much more) 🔵

Connect your own data

  1. Connect your database 🟠
  2. Create your first data model (so Embeddable can load data from your database) 🟠
  3. Apply row-level security (so end-users only see the data they're allowed to see) 🟢

Embed in your application

  1. Embed your dashboard (in your web application) 🟢