Note: This is the integrations/makeswift branch of Catalyst, which includes an integration with Makeswift for visual editing. This is the version of Catalyst deployed by default by the One-Click Catalyst functionality in the BigCommerce control panel. If you wish to use a version of Catalyst without a pre-integrated visual editor, consider the code on the canary branch or refer to the tags for the version that's best for you.

Catalyst is the composable, fully customizable headless commerce framework for BigCommerce. Catalyst is built with Next.js, uses our React storefront components, and is backed by the GraphQL Storefront API.

By choosing Catalyst, you'll have a fully-functional storefront within a few seconds, and spend zero time on wiring up APIs or building SEO, Accessibility, and Performance-optimized ecommerce components you've probably written many times before. You can instead go straight to work building your brand and making this your own.

Demo

• Catalyst Demo

🚀 catalyst.dev • 🤗 BigCommerce Developer Community • 💬 GitHub Discussions • 💡 Docs in this repo

Deploy via One-Click Catalyst App

The easiest way to deploy your Catalyst Storefront is to use the One-Click Catalyst App available in the BigCommerce App Marketplace.

Check out the Catalyst.dev One-Click Catalyst Documentation for more details.

Getting Started

Requirements:

• A BigCommerce account

• Node.js version 20 or 22

• Corepack-enabled pnpm

  corepack enable pnpm

1. Install the latest version of Catalyst:

   pnpm create @bigcommerce/catalyst@latest

2. Run the local development server:

   pnpm run dev

Learn more about Catalyst at catalyst.dev.

Resources

• Catalyst Documentation
• GraphQL Storefront API Playground
• GraphQL Storefront API Explorer
• BigCommerce DevDocs