create-spark-html-app
v1.2.0
Published
Scaffold a spark-html app — dev/build/preview on Bun
Maintainers
Readme
create-spark-html-app
Scaffold a Spark app in seconds — a
Bun-powered project (dev / build / preview via spark-html-bun) wired to
spark-html with live, reactive Spark components.
Usage
bunx create-spark-html-app@latest my-appThen:
cd my-app
bun install
bun run devRun it with no name to be prompted:
bunx create-spark-html-app@latestProject types — SSR & Prerender
bunx create-spark-html-app@latest myapp # client-only (default)
bunx create-spark-html-app@latest myapp --ssr # SSR with spark-ssr
bunx create-spark-html-app@latest myapp --prerender # static site with spark-prerenderWithout a flag (on a TTY) an interactive picker asks which one you want.
--ssr scaffolds the three-tier pattern — pages declare data with
<spark-ssr>, components are pure UI via <div import>, spark.json
holds the DB connection — plus a seeded SQLite dev database. No build step:
bun run dev and it serves.
--prerender scaffolds a minimal static site whose build writes
fully-rendered HTML into dist/ via spark-prerender.
What you get
The scaffold comes with the whole Spark ecosystem pre-wired — you delete what you don't need instead of wiring what you do:
| Always on | Optional (prompted) |
|-----------|---------------------|
| spark-html — the runtime | spark-html-router — multi-page SPA (default yes) |
| spark-html-head — reactive title/meta | spark-html-theme — dark/light toggle (yes) |
| spark-html-persist — localStorage store demo | spark-html-image — webp/avif + srcset at build (yes) |
| spark-prerender — SEO HTML + sitemap/robots | spark-html-sri — integrity checks (yes) |
| spark-html-devtools — dev-only inspector | spark-html-manifest — PWA manifest + icons + offline shell (no) |
Every included feature ships with a live demo component, ready to run.
Non-interactive? Pass flags instead of answering prompts:
bunx create-spark-html-app@latest my-app --yes # accept the defaults
bunx create-spark-html-app@latest my-app --all # everything on
bunx create-spark-html-app@latest my-app --minimal # core only
bunx create-spark-html-app@latest my-app --pwa --no-image # per-featureEverything is plain HTML and JavaScript — no compiler, no virtual DOM, no proprietary file format. Edit a component, save, and the page updates.
The Spark family
Small, single-purpose packages that share one philosophy: no compiler, no virtual DOM, no build step required — built for humans who love hand-writing their web apps. Add only what you use.
| Package | What it does |
|---|---|
| spark-html | The runtime — components, reactivity, stores, forms, scoped styles. ~14.6 kB gzip, 0 deps. |
| spark-html-bun | Dev server, bundler & preview on Bun — scoped HMR, no-build dev, post-build pipeline. |
| spark-html-router | <template route> routing — nested routes/layouts, route.query, active links. |
| spark-html-theme | Dark/light/system theming in one line — persisted, no flash. |
| spark-html-head | Reactive <title>/<meta> per route + a head store. |
| spark-html-motion | Enter/leave transitions on if/each blocks — transition="fade|slide|scale". |
| spark-html-devtools | In-page devtools — live stores, component tree, patch activity. |
| spark-html-query | Declarative async data — a self-fetching store (loading/error/data/refetch). |
| spark-html-persist | Persist stores to localStorage/sessionStorage in one line. |
| spark-html-websocket | A WebSocket as a reactive store — auto-reconnect, JSON, send(). |
| spark-prerender | Build-time SEO prerender + sitemap/robots — no SSR server. |
| spark-ssr | Full-stack SSR on Bun — the template is the backend: inferred DB, REST CRUD, auth, live updates. Precompiled + response-cached: fast by default. |
| spark-html-image | Build-time image optimization — webp/avif + responsive srcset, zero config. |
| spark-html-font | Font loading optimizer — preload + size-adjusted fallbacks, no FOUT. |
| spark-html-manifest | PWA manifest + icons + head tags (and optional service worker) from one config. |
| spark-html-offline | Offline URL imports — a service worker that caches CDN components. |
| spark-html-sri | Subresource Integrity — hash + verify assets and remote components. |
| create-spark-html-app | Scaffold a spark-html app in one command. |
| prettier-plugin-spark | Prettier for components — formats <script>/<style>, markup stays byte-for-byte. |
| spark-html-language-server | LSP — diagnostics, go-to-definition, prop autocomplete, hover docs. |
License
MIT
