Launch the designer

One command opens the visual app designer in your browser, backed by a tiny local server that auto-saves your design to disk and generates the app into a folder - no host app to build, no copy-paste JSON.

Build a data app in four no-code steps: open the designer, start from a sample or your database, arrange it visually, then generate the app.

You run one command to open the designer; everything after that is point-and-click - no coding.

npx @svgrid/studio designer

That serves the designer at http://localhost:4321 and opens it. Design your app - screens, entities, data sources, grid config - and every edit is saved to studio.config.json in the current folder as you work. A refresh (or a rerun) picks up exactly where you left off.

What it does

cd my-app                 # design saved here as studio.config.json
npx @svgrid/studio designer
# ... design, then Generate app -> Save to folder ...
npm install
npm run dev

Start from zero

The designer's onboarding screen: sample apps, New entity, Connect a database, or Import a schema

Launched in an empty folder, the designer opens on an onboarding screen - your app has no data model yet. The quickest start is a ready-made sample app (--template <id>, or the Sample apps button); otherwise add a data model one of these ways:

Opening a sample app gives you a complete, themed app in one click. Here the CRM sample - a dashboard with KPI tiles and a deal-pipeline chart, ready to explore or point at your own data:

The CRM sample loaded in the designer: KPI tiles (open deals, pipeline value, average deal size) and a bar chart of deal value by stage.

Connect a live database

Connect DB (toolbar) opens a wizard that reads your database and turns its tables into entities - no hand-typing a schema:

The Connect database wizard: pick which tables to import

  1. Pick the database (PostgreSQL / MySQL / SQL Server / SQLite / Supabase) and paste a connection string.
  2. The designer lists the tables; tick the ones you want.
  3. Add them - each becomes an entity + screen, with columns typed from the catalog and foreign keys turned into relations. Every added entity is bound to its SQL table, so Generate app emits a connected src/routes/api/<table>/+server.ts (driver + DATABASE_URL) for it.

The database driver (pg / mysql2 / mssql / better-sqlite3) must be installed in the folder you launched the designer in. The connection stays on your machine - the local designer server does the read; nothing is sent to a cloud. To scaffold from a schema file or a live DB straight from the terminal instead, use npx @svgrid/studio add.

Options

Flag Default Description
--config <path> ./studio.config.json The design file to load + auto-save.
--out <dir> . Folder the generated app is written into (Save to folder).
--port <n> 4321 Port to serve on.
--no-open - Don't open the browser (print the URL only).
# keep the design and the generated app in separate folders
npx @svgrid/studio designer --config ./design/app.json --out ./generated-app

How it fits together

The design is a StudioProject (the same model the app designer edits and the CLI can regenerate from). studio.config.json is that model on disk, so the designer, npx @svgrid/studio designer, and npm create @svgrid/studio -- --project ./studio.config.json all read and write the one file - design visually, regenerate from CI, or hand it to a teammate.

See also