Skip to content

Latest commit

 

History

History

core

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
app
app
 
 
build-config
build-config
 
 
client
client
 
 
components
components
 
 
data-transformers
data-transformers
 
 
i18n
i18n
 
 
lib
lib
 
 
messages
messages
 
 
middlewares
middlewares
 
 
scripts
scripts
 
 
tests
tests
 
 
.env.example
.env.example
 
 
.eslintrc.cjs
.eslintrc.cjs
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
auth.ts
auth.ts
 
 
channels.config.ts
channels.config.ts
 
 
middleware.ts
middleware.ts
 
 
next.config.ts
next.config.ts
 
 
package.json
package.json
 
 
playwright.config.ts
playwright.config.ts
 
 
postcss.config.js
postcss.config.js
 
 
prettier.config.js
prettier.config.js
 
 
tailwind.config.js
tailwind.config.js
 
 
tsconfig.json
tsconfig.json
 
 
userAgent.ts
userAgent.ts
 
 

README.md

Catalyst for Composable Commerce Image Banner

Catalyst is the composable, fully customizable headless ecommerce storefront 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.

-----------------------------------------------------

🚀 catalyst.dev • 🤗 BigCommerce Developer Community • 💬 GitHub Discussions

-----------------------------------------------------

Requirements

  • Node.js 20+
  • npm (or pnpm/yarn)

Getting started

If this installation of Catalyst was created using the catalyst CLI, you should already be connected to a store and can get started immediately by running:

npm run dev

If you want to connect to another store or channel, you can run the setup process again by running:

npx @bigcommerce/create-catalyst@latest init

Learn more about Catalyst at catalyst.dev.

Resources