Contentstack kickstart – kickstart-next
When to use
- You are changing how the app talks to Contentstack (delivery, preview, regions, hosts).
- You are extending or fixing assumptions about the
page content type or Live Preview field bindings.
Instructions
Entry points
- All stack configuration and fetching live in lib/contentstack.ts.
stack: created with contentstack.stack() from @contentstack/delivery-sdk, using API key, delivery token, environment, region, optional custom host, and live_preview options (preview token, preview host, enable flag).initLivePreview(): calls ContentstackLivePreview.init() from @contentstack/live-preview-utils with ssr: false, mode: "builder", stack SDK/config, stack details, client URL params, and edit button settings.getPage(url): queries the page content type, filters url with QueryOperation.EQUALS, and returns the first entry typed as Page from lib/types.ts. When isPreview is true, adds editable tags via contentstack.Utils.addEditableTags().
Preview vs production routing
Regions and endpoints
- Region resolution uses
getRegionForString from @timbenniks/contentstack-endpoints; getContentstackEndpoints(region, true) supplies default delivery, preview, and application hosts for that region.
- If region resolution fails, the stack falls back to
NEXT_PUBLIC_CONTENTSTACK_REGION as passed through in code (typed loosely for internal flexibility).
Optional environment overrides (advanced)
- Delivery host:
NEXT_PUBLIC_CONTENTSTACK_CONTENT_DELIVERY overrides the default from endpoints.
- Preview host:
NEXT_PUBLIC_CONTENTSTACK_PREVIEW_HOST overrides preview URL host.
- Application (Live Preview UI) host:
NEXT_PUBLIC_CONTENTSTACK_CONTENT_APPLICATION overrides clientUrlParams.host in initLivePreview.
- Image hostname for
next/image: NEXT_PUBLIC_CONTENTSTACK_IMAGE_HOSTNAME (see next.config.mjs).
Types and Live Preview attributes
- Entry and field shapes for CSLP live in lib/types.ts;
$ on entries/fields holds data-cslp / parent attributes. Keep these aligned with modular blocks and page fields expected from the seeded stack.
Seed alignment
- The app assumes a stack seeded from
contentstack/kickstart-stack-seed (“Kickstart Stack”) and tokens/scopes described in README.md. Changing content type UIDs or field UIDs requires matching code and type updates.
