Deploying to Vercel

Prerequisites

Before you get started, you need to have:

• A Vercel account.
• A commercetools account and a Project.
• A Custom View configured in the Merchant Center.

Configuration

In your Custom View config, provide the Custom View ID you got when you configured the Custom View in the Merchant Center.

Moreover, you need to provide the production URL from your Vercel project. You can keep the standard Vercel URL https://<project>.vercel.app or provide your custom domain.

const config = {
  "env": {
    "production": {
      "customViewId": "ckvtahxl90097sys6har1e6n3",
      "url": "https://<project>.vercel.app"
    }
  }
  // ...
}

Using environment variables

In case you want to avoid hardcoding certain values, for example the Custom View ID, or the Project key, you can use variable placeholders in your Custom View config.

const config = {
  "env": {
    "production": {
      "customViewId": "${env:CUSTOM_VIEW_ID}",
      "url": "https://<project>.vercel.app"
    }
  }
  // ...
}

Connect Vercel with GitHub

The easiest way to deploy to Vercel is to use the GitHub integration.

Follow the steps in Vercel to create and import a new Git repository.

Configuring build settings

In the Vercel setup process you need to configure the following things:

• Select Create React App as the Framework Preset.

• Override the Build command with: yarn build.

  In your package.json make sure to have the following scripts defined:

  package.jsonjson

  {
    "scripts": {
      "build": "mc-scripts build"
    }
  }

• Override the Output directory with: public.

• If possible, select or specify the Node.js Version. Recommended version is >= v18.

Test your deployment

In the Merchant Center you can now follow the steps to install the Custom View and access it in your Projects.