Clone and Run

Beta

The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.

Get the Accelerator running locally with your Propeller environment. The Accelerator is a complete working storefront app that uses SDK Services and UI Components internally.

Prerequisites

• Node.js 18 or higher
• A Propeller environment with a GraphQL API endpoint and key (how to get credentials)

Step 1: Clone the repository

git clone https://github.com/propeller-commerce/propeller-sdk-v2.git
cd propeller-sdk-v2

Step 2: Install and configure

npm install

Copy the example environment file and fill in your Propeller credentials. You need your GraphQL endpoint URL and API key.

cp .env.example .env.local

Open .env.local and set the values for your environment.

Step 3: Start the development server

npm run dev

Open http://localhost:3000 in your browser. You should see a working frontend with your product catalog.

Next steps

Continue to What's Next for links to guides on the SDK layers, customization and commerce domains.