Getting Started

Prerequisites

Before you begin, ensure you have met the prerequisites listed below on your local machine.

Node.js version 20.x

Catalyst currently supports Node.js version 20.x (click here to download Node.js (opens in a new tab))

Corepack-enabled pnpm

Node.js version 20.x ships with Corepack by default; you should be able to run corepack enable from your terminal to meet this prerequisite (more information on the official Node.js Corepack documentation (opens in a new tab))

Git version 2.35.x or later

Click here to download Git (opens in a new tab)

A BigCommerce store or sandbox

You can create a trial store (opens in a new tab) or spin up a developer sandbox (opens in a new tab) to meet this prerequisite. If you already have a BigCommerce store, that will work fine too.

Permission to create API accounts on your store

In order to allow Catalyst to authenticate with your BigCommerce store, you'll need to make sure that your user account on the subject store has been granted the Create store-level API Accounts permission detailed in our documentation on High-Risk Permissions (opens in a new tab). If you are the assigned store owner of the store, you have these permissions implicitly.

A GitHub account

You can sign up for a free GitHub account on the official GitHub signup page (opens in a new tab).