@apollosproject/web-embeds 0.1.563 → 0.1.564

package/README.md

@@ -60,7 +60,10 @@ Apollos session and no `personOriginId` is passed.
 apollos("init", { slug: "your-church-slug" });
 
 // After (with migration detection — Rock RMS example)
-apollos("init", { slug: "your-church-slug", personOriginId: "${CurrentPerson.Id}" });
+apollos("init", {
+  slug: "your-church-slug",
+  personOriginId: "${CurrentPerson.Id}",
+});
 ```
 
 If the id isn't known at `init` time, the embed also reads a `personoriginid`
@@ -83,10 +86,31 @@ npm run build
 
 ### Crossroads test page
 
-The `public/crossroads-test/` directory contains a demo giving page. The embed base URL and church slug are configurable via env vars:
+The `public/crossroads-test/` directory contains a demo giving page. The embed base URL, church slug, and embed script URL are configurable via env vars and injected into the `*.template.html` files:
 
-- **Local dev:** Create `.env` in `apps/web-embeds-v2/` (see `.env.example`). Run `npm run inject-config` or `npm run dev` to generate `index.html` from the template.
-- **GitHub Pages:** Set `APOLLOS_EMBED_BASE_URL` and `APOLLOS_EMBED_CHURCH_SLUG` in repo Settings → Variables and secrets → Actions. The workflow deploys on push to `main` when crossroads-test files change. Enable Pages in Settings → Pages → Source: GitHub Actions. The same deploy publishes both `index.html` (giving page) and `giving-history.html` (giving history page with Recurring Gifts → modal); use `/` and `/giving-history.html` on your Pages URL.
+- **Local dev:** Create `.env` in `apps/web-embeds-v2/` (see `.env.example`). Run `npm run inject-config` or `npm run dev` to generate `index.html` / `giving-history.html` from the templates. The generated `*.html` files are gitignored — only the `*.template.html` sources are committed.
+
+## Demo site (hosted)
+
+The demo pages in `public/` are deployed to a persistent URL via **Vercel**, which also creates a preview deployment for every pull request that touches this app.
+
+- **What's deployed:** the entire `public/` folder (so any file added there is picked up automatically) plus a fresh `dist/embed.js` built from that branch — so PR previews reflect the actual embed behavior of the change. The `crossroads-test` templates are injected at build time.
+- **Build:** `yarn build:site` runs `inject-embed-config.js` → `vite build` → `scripts/build-demo-site.mjs`, which assembles the `site/` output directory (mirrors the dev-server layout: `public/` files at the web root, the widget at `/dist/embed.js`). `site/` is gitignored.
+- **Pages:** `/` is a menu (`public/index.html`) linking to each demo — `/demo.html` (embed playground), `/crossroads-test/` (giving), `/crossroads-test/giving-history.html` (recurring gifts → modal). Add a link to the menu whenever you add a new host page to `public/`.
+
+**One-time Vercel project setup** (dashboard, per the [Vercel monorepo docs](https://vercel.com/docs/monorepos)):
+
+1. **New Project** → import this repo → set **Root Directory** to `apps/web-embeds-v2`.
+2. Framework Preset: **Other** (build/install/output come from `vercel.json`).
+3. Add **Environment Variables** (Production + Preview):
+   - `APOLLOS_EMBED_BASE_URL` — the web-app origin the embeds point at (e.g. `https://apollos.app`)
+   - `APOLLOS_EMBED_CHURCH_SLUG` — demo church slug (e.g. `apollos-demo`)
+   - `APOLLOS_EMBED_SCRIPT_URL` — leave as `/dist/embed.js` to use the bundle built on this deploy, or set a CDN URL to pin a published version.
+4. Under Settings → Git, enable **"Only build when there are changes in the Root Directory"** so unrelated commits don't redeploy.
+
+Production (the `main` branch) is the persistent URL; each PR gets its own preview URL commented on the PR.
+
+> Note: `demo.html` / `search-demo.html` are dev harnesses that resolve the embedded web app from the page's own origin, so on the hosted site they'll only render fully against a same-origin backend. The `crossroads-test` pages are the fully-configured showcase (backend wired via the env vars above).
 
 ## Publishing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollosproject/web-embeds",
-  "version": "0.1.563",
+  "version": "0.1.564",
   "description": "Next-generation embeddable widget system for Apollos",
   "type": "module",
   "main": "./widget/embed.js",
@@ -19,6 +19,7 @@
     "inject-config": "node scripts/inject-embed-config.js",
     "dev": "node scripts/inject-embed-config.js && vite",
     "build": "tsc && vite build && node scripts/build.cjs",
+    "build:site": "node scripts/inject-embed-config.js && vite build && node scripts/build-demo-site.mjs",
     "preview": "vite preview",
     "type-check": "tsc --noEmit",
     "test": "vitest",