@flatbread/explorer

Content-relation explorer for Flatbread. v1 ships a generic single-page app (SPA) shell plus a Proof preset. When your config uses proofContent(), flatbread start serves this UI at /.

Try it locally

# flatbread.config.js includes proofContent()
npx flatbread start --watch --open
# → http://localhost:5057/          explorer
# → http://localhost:5057/graphql   Apollo sandbox

No separate Next.js app is required. Flatbread checks for the prebuilt assets under dist/static/ (see Develop in the monorepo). When those assets are missing, Flatbread does not serve the explorer and npx flatbread start --open opens /graphql instead. pnpm play:efforts runs the explorer build automatically.

Static deploy

This package publishes prebuilt assets under dist/static/. Drop them on any static host and point at a reachable Flatbread GraphQL endpoint:

https://your-host.example/?endpoint=https://api.example.com/graphql

Same-origin deploys (assets served by Flatbread) need no query param.

What the package exports

| Export | Role | | ------------------------------ | ------------------------------------------ | | getExplorerStaticDir() | Absolute path to dist/static for Express | | explorerAssetsPresent() | Whether prebuilt index.html exists | | matchExplorerPreset(content) | Detect Proof (and later presets) | | EXPLORER_BOOTSTRAP_PATH | Bootstrap JSON path Flatbread injects |

There is no public React component export in v1.

Develop in the monorepo

pnpm --filter @flatbread/explorer test
pnpm play:efforts   # builds explorer, then flatbread start --watch --open

For UI-only iteration with hot module replacement (HMR), run Flatbread and Vite in separate terminals (Vite proxies /graphql and /events to Flatbread on port 5057, or FLATBREAD_PORT when set):

pnpm exec flatbread start --watch          # terminal 1 — GraphQL on :5057
pnpm --filter @flatbread/explorer dev      # terminal 2 — SPA on :5173