For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
You now have a working single-click app: a BigDesign interface, real BigCommerce REST API calls, the OAuth install and launch flow, session management with two-tier authorization, and per-store credentials in a shared Postgres database.
From here, you can examine the other features and production enhancements included in the starter app, or you might remove the “Gift Certificate Manager”
example feature and start building your own app using the full app foundation.
Continue with the enhanced example app
The full version of the starter app includes several features and enhancements
not covered in the tutorial, such as:
Uninstall and remove-user callbacks
Handles the two server-to-server callbacks BigCommerce fires when a store owner uninstalls the app or a user’s access is revoked, deleting the relevant credentials rows in a single transaction.
Caching and memoization
Adds use cache boundaries with cache tags and lifetimes, per-request memoization of credential resolution, and updateTag calls from mutations so a write is visible immediately rather than waiting out the cache lifetime.
Rate-limit and timeout behavior
Teaches the REST client to respect BigCommerce’s rate-limit headers and to fail predictably on slow upstream responses instead of hanging a request.
Customers feature
A second complete feature, adding a Customers section listing the gift certificates belonging to a given customer.
Gift certificate enhancements
List filtering, balance actions, customer account decoration, and a transfer-to-store-credit flow that debits a certificate and credits a customer.
GraphQL client and app extensions
Adds a GraphQL API client alongside the REST one, and registers an app extension on install so the app appears as a shortcut inside the control panel’s own customer pages.
Cross-origin control panel links
Navigates the parent frame from inside the app’s cross-origin iframe, so the app can link into native control panel pages it doesn’t reimplement.
Vercel deployment scaffolding
The opt-in pnpm scaffold vercel tooling — a migration-aware build script and a generated environment variable reference — kept out of the base app so the starter stays provider-neutral.
Cloudflare Workers scaffolding
The opt-in pnpm scaffold cloudflare deploys the app to Cloudflare Workers through the OpenNext adapter: a D1-backed credentials store driver, Wrangler configuration and deployment scripts, and a script that swaps the app’s Cache Components caching for fetch-level caching.
See the tutorial reference in the repository documentation
for full Git diffs of each of these features, listed after the main exercises from this tutorial.
Use the starter for your own app
The structure of this starter app intentionally keeps common utilities (for single-click authentication flow, API client, session management, etc)
cleanly separated from the Gift Certificate Manager example feature. You can build your own BigCommerce app on Next.js directly on top
of the starter app’s common foundation.
Clone, fork, or copy the full starter app, then see the Using This App as a Starter
guide in the repository documentation for details on what to keep, remove, and update to make the app your own.
