@svgrid/create-studio 0.2.1 → 0.4.0

package/LICENSE

@@ -1,28 +1,3 @@
-This repository is a multi-package workspace. Different packages ship
-under different licenses. The authoritative license for each package is
-the LICENSE file inside that package directory.
-
-------------------------------------------------------------------------
-Per-package licensing
-------------------------------------------------------------------------
-
-  packages/grid/       MIT (terms below, and packages/grid/LICENSE)
-  packages/enterprise/        Commercial - see packages/enterprise/LICENSE
-  packages/mcp/        Commercial - see packages/mcp/LICENSE
-  website/                     Proprietary - see website/LICENSE
-
-Only `@svgrid/grid` is open source. Everything else in this
-repository (the Pro feature pack, the MCP server, the marketing +
-docs website, and any other package added later that does not ship
-its own MIT LICENSE) is proprietary and may not be copied, modified,
-or redistributed without a paid license. Source is visible in this
-repository for transparency and for paying customers; visibility does
-not grant a license.
-
-------------------------------------------------------------------------
-MIT License (applies ONLY to packages/grid)
-------------------------------------------------------------------------
-
 MIT License
 
 Copyright (c) 2026 jQWidgets Ltd

package/README.md

@@ -1,4 +1,23 @@
-# @svgrid/create-studio
+<p align="center">
+  <img src="https://svgrid.com/brand/svgrid-logo-icon-1200.png" alt="SvGrid" width="100" height="100" />
+</p>
+
+<h1 align="center">@svgrid/create-studio</h1>
+
+<p align="center"><strong>Scaffold a runnable SvelteKit data app in one command.</strong></p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@svgrid/create-studio"><img src="https://img.shields.io/npm/v/%40svgrid%2Fcreate-studio.svg?label=%40svgrid%2Fcreate-studio" alt="npm version" /></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" /></a>
+</p>
+
+<p align="center">
+  <a href="https://svgrid.com">Website</a> ·
+  <a href="https://svgrid.com/docs/">Docs</a> ·
+  <a href="https://svgrid.com/pricing/">Pricing</a>
+</p>
+
+---
 
 Scaffold a runnable **SvGrid Studio** data app in one command.
 
@@ -32,7 +51,7 @@ npm create @svgrid/studio@latest my-app -- --from ./src/lib/db/schema.ts
 
 ## From a designer project
 
-Export a `studio.config.json` from the [visual app designer](https://www.svgrid.com/docs/enterprise/studio/app-designer)
+Export a `studio.config.json` from the [visual app designer](https://svgrid.com/docs/enterprise/studio/app-designer/)
 and generate the exact screens + blocks you arranged:
 
 ```bash
@@ -87,6 +106,6 @@ The grid, form, sorting, filtering, and paging keep working unchanged.
 
 ## Links
 
-- Docs: https://www.svgrid.com/docs/studio
+- Docs: https://svgrid.com/docs/enterprise/studio/
 - Grid: [`@svgrid/grid`](https://www.npmjs.com/package/@svgrid/grid)
 - Studio / enterprise: [`@svgrid/enterprise`](https://www.npmjs.com/package/@svgrid/enterprise)

package/index.mjs

@@ -85,11 +85,14 @@ ${color('bold', 'Examples')}
   npm  create @svgrid/studio@latest my-app -- --from ./prisma/schema.prisma
   npm  create @svgrid/studio@latest my-app -- --project ./studio.config.json
   npm  create @svgrid/studio@latest my-app -- --theme material --dark
+
+${color('bold', 'Have a database?')}
+  npx @svgrid/studio init   reads your tables and scaffolds a page for each.
 `)
 }
 
 const THEME_IDS = [
-  'shadcn', 'tailwind', 'material', 'excel', 'fluent', 'carbon', 'sap',
+  'ember', 'shadcn', 'tailwind', 'material', 'excel', 'fluent', 'carbon', 'sap',
   'salesforce', 'atlassian', 'github', 'antd', 'ag-alpine', 'bootstrap',
   'vercel', 'linear', 'notion', 'nord', 'dracula', 'catppuccin',
 ]
@@ -187,6 +190,9 @@ async function applyProject(destDir, projectPath) {
   const files = studio.emitStudioAppBundle(project)
   for (const f of files) {
     const full = join(destDir, f.path)
+    // User-owned companions (handlers.ts) are write-once: never overwrite an
+    // existing one on regeneration - same contract as the designer server.
+    if (typeof studio.skipUserOwned === 'function' && studio.skipUserOwned(f, existsSync(full))) continue
     await mkdir(dirname(full), { recursive: true })
     await writeFile(full, f.contents)
   }
@@ -373,7 +379,8 @@ async function main() {
   stdout.write(`  cd ${target}\n`)
   stdout.write(`  npm install\n`)
   stdout.write(`  npm run dev\n\n`)
-  stdout.write(`${color('dim', 'Docs:')} https://www.svgrid.com/docs/studio\n\n`)
+  stdout.write(`${color('dim', 'Have a database?')} npx @svgrid/studio init ${color('dim', 'reads your tables and scaffolds a page for each.')}\n`)
+  stdout.write(`${color('dim', 'Docs:')} https://svgrid.com/docs/enterprise/studio/\n\n`)
 }
 
 main().catch((err) => {

package/package.json

@@ -4,15 +4,15 @@
     "type": "commercial",
     "url": "https://svgrid.com/pricing"
   },
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Scaffold a runnable SvGrid Studio data app in one command: npm create @svgrid/studio@latest",
   "type": "module",
   "license": "MIT",
   "author": "jQWidgets Ltd",
-  "homepage": "https://www.svgrid.com",
+  "homepage": "https://svgrid.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sv-grid/sv-grid.git",
+    "url": "git+https://github.com/sv-grid/sv-grid.git",
     "directory": "packages/create-studio"
   },
   "keywords": [
@@ -41,6 +41,6 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@svgrid/enterprise": "^2.2.1"
+    "@svgrid/enterprise": "^2.4.0"
   }
 }

package/templates/default/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+# Build + type-check every push. Generated by SvGrid Studio.
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm install
+      - run: npm run check
+      - run: npm run build

package/templates/default/DEPLOY.md

@@ -0,0 +1,47 @@
+# Deploying
+
+This app uses SvelteKit's `@sveltejs/adapter-auto`, which detects Vercel, Netlify,
+and Cloudflare Pages automatically at build time. A CI workflow
+(`.github/workflows/ci.yml`) checks + builds every push.
+
+## Environment variables
+
+Nothing is required while the app runs on its seeded in-memory data. When you
+connect a real database or add auth, copy `.env.example` to `.env` locally and
+set the same variables in your host's dashboard (see `.env.example` for the
+list).
+
+## Option A - Git integration (simplest)
+
+1. Push this repo to GitHub.
+2. Import it at your provider - <https://vercel.com/new>,
+   <https://app.netlify.com/start>, or <https://dash.cloudflare.com/> (Pages) -
+   the SvelteKit build is auto-detected.
+3. Add any environment variables in the host's dashboard.
+
+Every push to `main` then redeploys automatically.
+
+## Option B - Deploy from your machine
+
+```bash
+npm run deploy        # runs: npx vercel deploy --prod
+```
+
+Prefer Netlify or Cloudflare? Use `npx netlify deploy --build --prod` or
+`npx wrangler pages deploy` instead, and consider pinning the matching SvelteKit
+adapter in `svelte.config.js` (`@sveltejs/adapter-netlify` /
+`@sveltejs/adapter-cloudflare`).
+
+## Connecting a real database before deploy
+
+The starter's grids run on in-memory seed data - a deployed copy works, but data
+resets on every restart and isn't shared between visitors. To go persistent:
+
+1. Bind your entities to a database - the fastest path is the Studio designer
+   (`npx @svgrid/studio designer`) or `npx @svgrid/studio add <table> --db
+   postgres --url "$DATABASE_URL"`.
+2. Regenerate; the emitted app then includes the connected API routes and a
+   `DEPLOY.md` with database-specific steps (tables, migrations, seeding).
+3. Set `DATABASE_URL` locally and on your host.
+
+Docs: <https://svgrid.com/docs/enterprise/studio/>

package/templates/default/README.md

@@ -1,6 +1,8 @@
 # My Studio App
 
-A data app built with [SvGrid Studio](https://www.svgrid.com/docs/studio).
+A SvelteKit data app built with
+[SvGrid Studio](https://svgrid.com/docs/enterprise/studio/) and the
+[SvGrid](https://svgrid.com) data grid.
 
 ```bash
 npm install

package/templates/default/_env.example

@@ -0,0 +1,15 @@
+# Environment variables. This starter runs fully in-memory, so nothing here is
+# required to start - copy to .env and fill in as you grow the app.
+
+# Your database connection string, once you bind entities to a real database
+# (Neon / Supabase / Postgres / MySQL / SQLite path). See DEPLOY.md.
+# DATABASE_URL=
+
+# Turso / libSQL auth token (only for Turso).
+# DATABASE_AUTH_TOKEN=
+
+# Session signing secret - required if you add authentication. Use a long random value.
+# SESSION_SECRET=
+
+# Optional: your SvGrid license key removes the unlicensed watermark.
+# VITE_SVPRO_KEY=

package/templates/default/_package.json

@@ -7,7 +7,8 @@
     "dev": "vite dev",
     "build": "vite build",
     "preview": "vite preview",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "deploy": "npx vercel deploy --prod"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^6.0.0",

package/templates/default/src/lib/data.ts

@@ -5,10 +5,10 @@
  * one with `npx @svgrid/studio add <table> --db postgres --url ...`) - the grid,
  * form, sorting, filtering, and paging keep working unchanged.
  */
+import type { ServerDataSource } from '@svgrid/grid'
 import {
   createInMemoryDataSource,
   createRelationLookup,
-  type ServerDataSource,
 } from '@svgrid/enterprise'
 import { customerSchema, orderSchema, productSchema, type Customer, type Order, type Product } from './schemas'
 

package/templates/default/src/routes/+layout.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
   import '../app.css'
-  import { page } from '$app/stores'
+  import { page } from '$app/state'
 
   let { children } = $props()
 
@@ -17,7 +17,7 @@
     <a class="app__brand" href="/">My Studio App</a>
     <nav class="app__links">
       {#each nav as item (item.href)}
-        <a class="app__link" class:is-active={$page.url.pathname === item.href} href={item.href}>{item.label}</a>
+        <a class="app__link" class:is-active={page.url.pathname === item.href} href={item.href}>{item.label}</a>
       {/each}
     </nav>
     <span class="app__foot">Built with SvGrid Studio</span>