Skip to content

electric-sql/shape-explorer

Repository files navigation

Electric Shape Explorer

A web interface for exploring Shape queries to your Electric server. This tool provides a simple way to query Electric and visualize the results.

npx git-scaffold electric-sql/shape-explorer shape-explorer

Image

Features

  • Simple Query Interface: Enter table names and WHERE clauses to query your data
  • Real-time Results: See your query results instantly
  • Keyboard Shortcuts: Submit queries quickly with Cmd/Ctrl + Enter
  • Shareable URLs: Share queries easily with URL-based state

Use with Electric Cloud

Copy .env.sample to .env and then add your SOURCE_ID and SOURCE_SECRET.

Why Electric SQL?

Electric SQL syncs subsets of your Postgres data into local apps and services. Here's what it solves:

State Transfer

  • Replaces data fetching with data sync
  • Simplifies your code
  • Eliminates loading spinners

Cache Invalidation

  • Replaces TTLs and expiry policies with realtime sync
  • Automated invalidation
  • No more stale data

Scaling

  • Takes query workload off your database
  • Reduces compute workload on your cloud
  • Lowers cloud bills

Getting Started

  1. Install dependencies:

    npm install
  2. Start the development server:

    npm run dev
  3. Open http://localhost:3000 to start exploring your Electric database

Using Shape Explorer

  1. Enter a table name in the "Table Name" field
  2. Optionally add a WHERE clause to filter results
  3. Click "Query" or press Cmd/Ctrl + Enter to execute
  4. View results in the table below

Environment Variables

  • ELECTRIC_URL: Your Electric SQL service URL
  • ELECTRIC_SOURCE_SECRET: Your Electric source secret
  • ELECTRIC_SOURCE_ID: Your Electric source ID

Learn More

About

Playground for creating shapes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published