Getting Started with Create WooNext App

This guide walks you through running create-woonext-app to generate your WooGraphQL-powered Next.js storefront.

• Node.js 18 or higher
• npm, pnpm, yarn, or bun package manager

Your WordPress site needs:

1. WPGraphQL v1.16 or higher
2. WPGraphQL for WooCommerce v0.18 or higher
3. WooGraphQL Pro v1.4 or higher (optional, for premium product types)

A valid WooGraphQL Pro license is required. Get yours at woographql.com/pro.

Run the CLI with your license key:

npx create-woonext-app YOUR_LICENSE_KEY

Follow the interactive prompts to configure your project.

npx create-woonext-app <license> [options]

Arguments:
  <license>           Your WooGraphQL Pro License key

Options:
  -h, --help          Show help
  -v, --version       Show CLI version
  --use-npm           Use npm as package manager
  --use-pnpm          Use pnpm as package manager
  --use-yarn          Use yarn as package manager
  --use-bun           Use bun as package manager
  --next-version      Specify Next.js version

The create-woonext-app CLI performs these steps:

1. Creates a Next.js app using create-next-app with your chosen options
2. Installs dependencies including premium @woographql packages
3. Runs the woonext install script from @woographql/next

After the base Next.js app is created, the CLI runs the woonext install command from @woographql/next. This script:

• Prompts for WordPress endpoint configuration
• Generates pages, API routes, and components
• Sets up GraphQL operations for your selected product types

For detailed documentation on the install script options and generated files, see the @woographql/next documentation.

After generation completes:

cd my-store
npm run dev

Your storefront will be available at http://localhost:3000.

The generated project includes these packages:

Your license key is stored in .npmrc to access private packages:

registry=https://registry.npmjs.org/
@woographql:registry=https://yeetsquad.net/
//yeetsquad.net/:_authToken="YOUR_LICENSE_KEY"
always-auth=true

Important: Keep your license key secure. Don't commit .npmrc to public repositories.

• Learn about generated files in the @woographql/next documentation
• Understand session management with @woographql/session-utils
• Explore React hooks in @woographql/react-hooks