datasync-boilerplate

Use for DataSync wiring—index.js, config, listener, asset/content stores, and Contentstack settings.

npx skills add https://github.com/contentstack/datasync-boilerplate --skill datasync-boilerplate

DataSync boilerplate app – Contentstack DataSync Boilerplate

When to use

  • Editing startup, checkpoint, or plugin behavior
  • Choosing or configuring content store, asset store, or listener modules
  • Documenting or fixing integration with Contentstack delivery API / webhooks

Instructions

  • Entry point: index.js loads config/all.js, merges config/<NODE_ENV>.js when that file exists (else config/development.js), optionally reads a checkpoint file for sync_token, then wires datasyncManager with listener, asset store, and content store from module paths in config (listenerModule, assetStoreModule, contentStoreModule).
  • Configuration: Put stack credentials and module names in config/—see product docs in root README.md for apiKey, delivery token, host, and webhook setup (ngrok, /notify, publish actions).
  • Published packages: Behavior is implemented in @contentstack/datasync-manager, @contentstack/webhook-listener, and the filesystem/MongoDB store packages listed in package.json; this repo only composes them.
  • Plugins: Custom plugins live under plugins/ per patterns already described in config/all.js.

More skills from contentstack

brand-kit-assistant
contentstack
Advise users on Contentstack Brand Kit concepts, setup, governance, and on-brand AI generation. Route API-specific tasks to the right Brand Kit capability or…
official
cms-assets
contentstack
Advise developers on organizing, delivering, and transforming assets in Contentstack. Cover folder structure, Image Delivery API transformations, publishing…
official
cms-branches-aliases
contentstack
Advise developers on using Contentstack branches for isolated content development and aliases for zero-downtime content deployments. Cover branch strategy,…
official
cms-data-modeling-best-practices
contentstack
Guide developers to model content in Contentstack using the simplest reusable structure. The skill explains when to use content types, references, global…
official
cms-entries
contentstack
Advise developers on querying, localizing, versioning, publishing, and structuring Contentstack entries for efficient delivery. Focus on CDA usage, reference…
official
cms-environments-publishing
contentstack
Advise developers on configuring environments, publishing content, using delivery and preview tokens, leveraging the Sync API, and understanding CDN and…
official
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnose and guide Contentstack Live Preview and Visual Builder implementations. Trace preview context, identify the broken contract, and recommend the…
official
cms-localization
contentstack
Advise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…
official