@vue-storefront/nuxt

Quick Setup

1. Add @vue-storefront/nuxt dependency to your project

# Using pnpm
pnpm add -D @vue-storefront/nuxt

# Using yarn
yarn add --dev @vue-storefront/nuxt

# Using npm
npm install --save-dev @vue-storefront/nuxt

2. Add @vue-storefront/nuxt to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["@vue-storefront/nuxt"],
});

3. Configure the module

To configure the module, use vsf key in the Nuxt configuration object and provide necessary information such as the Middleware instance address:

export default defineNuxtConfig({
  modules: ["@vue-storefront/nuxt"],
  vsf: {
    middleware: {
      apiUrl: "http://localhost:4000"
    }
  },
});

4. Create SDK config file - sdk.config.ts in root directory of your project:

The defineSdkConfig function is used for this purpose. The parameter for calling this function should be an anonymous function that receives an injected context from the module, containing:

• the buildModule function,
• the middleware URL (middlewareUrl),
• a function for retrieving the Cookie header with cookie values (getCookieHeader).

You should import all other SDK configuration components. See the example below illustrating the SDK configuration with Unified and Contentful modules.

import {
  contentfulModule,
  ContentfulModuleType,
} from "@vsf-enterprise/contentful-sdk";
import { unifiedModule } from "@vsf-enterprise/unified-sdk";
import type { UnifiedApiExtension } from "../storefront-middleware/middleware.config";

export default defineSdkConfig(
  ({ buildModule, middlewareUrl, getCookieHeader }) => ({
    unified: buildModule(unifiedModule<UnifiedApiExtension>, {
      apiUrl: middlewareUrl + "/commerce",
      requestOptions: {
        headers: getCookieHeader,
      },
    }),
    contentful: buildModule<ContentfulModuleType>(contentfulModule, {
      apiUrl: middlewareUrl + "/cntf",
    }),
  }),
);

That's it! You can now use VueStorefront Module in your Nuxt app ✨