shopify-app-nuxt

A Nuxt module for building Shopify apps — authentication, webhooks, billing, Polaris components, and App Bridge integration. The Nuxt equivalent of @shopify/shopify-app-react-router.

Important

This package is a release candidate. The API is mostly stable but may still change before the 1.0 release.

Quick start

npx nuxi@latest module add shopify-app-nuxt

Then configure your API credentials and app URL in nuxt.config.ts:

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['shopify-app-nuxt'],
  shopify: {
    apiKey: 'your-api-key',
    apiSecretKey: 'your-api-secret',
    appUrl: 'https://your-app-url.com'
  }
})

Documentation

For full documentation, guides, and API reference, visit the docs:

https://shopify-app-nuxt.vercel.app

License

MIT

Contributing

Local development

# Install dependencies
bun install

# Generate type stubs
bun run dev:prepare

# Develop with the playground
bun run dev

# Build the playground
bun run dev:build

# Run ESLint
bun run lint

# Run Vitest
bun run test
bun run test:watch

# Release new version
bun run release