Documentation
Get started with SHOPin.
Set up, run, and extend the storefront accelerator. Guides for the BFF, presentation app, integrations and contracts — the same notes the team plays from.
New here?
Clone, install,
run in minutes.
The repo is the canonical reference. Pull it down, install with npm, and start the BFF and storefront side by side.
# clonegit clone git@github.com:creativestyle/shopin.gitcd shopin# configure env, then fill in valuescp .env.example .env# installnpm install# build core packages, then start dev (presentation + BFF)npm run setupnpm run dev
Explore the docs
Pick the chapter
that fits your task.
Each chapter is self-contained — no need to read them in order.
How to set up SHOPin
Bootstrap from the template: remove demo packages, wire your first integration, and deploy.
- Remove demo functionality
- Set up Commercetools / Mock / Contentful
- Deploy project apps
How to work with SHOPin
Workflow, building blocks, the BFF data layer, cart and authentication, validation and resilience.
- Features & components
- BFF, data sources, integrations
- Cart & authentication
Advanced topics
Performance and project-health rules — workspaces, cache strategies, CDN configuration and SEO controls.
- Cache strategies
- CDN configuration
- SEO & indexing control
Popular pages
Jump straight
to what you need.
Source of truth
The repo is
the map.
Source code lives on GitHub and is the canonical reference — this site is the guide to it. Browse the monorepo, open issues, and send PRs.
Stuck on a chapter?
Open an issue,
get an answer.
Docs are maintained alongside the code on GitHub. PRs are welcome; questions become issues, issues become guides.