Next.js + BigCommerce (Sam)

A Next.js 13 and App Router-ready headless storefront template for BigCommerce, featuring:

• Next.js App Router
• Optimized for SEO using Next.js's Metadata
• React Server Components (RSCs) and Suspense
• Route handlers for mutations
• Edge runtime
• New fetching and caching paradigms
• Dynamic OG images
• Styling with Tailwind CSS
• Automatic light/dark mode based on system settings

Prerequisites

Next.js + BigCommerce requires a BigCommerce sandbox or a production store provisioned to run a headless storefront.

To get started, use this README and the example environment variable comments.

Develop locally

To automatically clone the template repo and configure Vercel environment variables for your project, use the Deploy with Vercel button at the beginning of this README. After you complete the interactive configuration sequence, you can clone the automatically-created project to your local environment.

You can also clone the template repo manually and supply the environment variables defined in .env.example. The best practice is to use Vercel environment variables for this, but a .env file is all that is necessary.

Note: Do not commit your .env file. It exposes secrets that allow others to control your BigCommerce store.

1. Install the Vercel CLI:

npm i -g vercel

2. Link your local instance with the desired Vercel and GitHub accounts. This action creates a .vercel directory:

vercel link

3. Download the Vercel environment variables:

vercel env pull

4. Install the app's default dependencies and start the development server:

pnpm install
pnpm dev

The app runs on localhost:3000.

Configure checkout

• Optimized One-Page Checkout
• Stencil theme to customize checkout page and inform styling of shopper emails

Get to know the BigCommerce GraphQL Storefront API

In addition to being compatible with BigCommerce's multi-storefront features, Next.js + BigCommerce uses the GraphQL Storefront API. This API makes it possible for merchants to control the representation of products and categories, carts, orders, customer segmentation, and more. To get a sense of what is possible to do directly on the storefront, check out the GraphQL Playground.

When you access the Playground through the store control panel, BigCommerce provides a valid GraphQL Storefront authentication token without any additional API calls on your part. To access the dedicated GraphQL Playground for a particular sandbox or store, sign in to its BigCommerce account and navigate to Settings > API, then click Storefront API Playground.

Explore BigCommerce features

BigCommerce's open SaaS feature set powers your store. Visit the BigCommerce developer documentation to learn more about your options for the following features:

Core store configuration:

• Catalog management
• Multi-Storefront and alternate channel sales
• Buy Online, Pick up in Store, also known as Click and Collect
• Webhooks

Shopper journeys:

• GraphQL Storefront Faceted Search
• Promotions
• Customer Segmentation
• GraphQL Storefront Carts and Checkouts
• Abandoned Carts
• Payments
• Tax
• Orders
• Emails
• Shipping

Join our developer community

We invite you to give feedback and ask questions in our Developer Community BigCommerceDevs Slack or on our Discord server.