Deploying to Netlify

Prerequisites

Before you get started, you need to have:

• A Netlify 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 Netlify site. You can keep the standard Netlify URL https://<site>.netlify.app or provide your custom domain.

const config = {
  "env": {
    "production": {
      "customViewId": "ckvtahxl90097sys6har1e6n3",
      "url": "https://<site>.netlify.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://<site>.netlify.app"
    }
  }
  // ...
}

Connect Netlify with GitHub

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

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

Configuring build settings

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

• 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.

Configuring rewrite rules

A Custom View is a Single-Page Application that uses client-side routing. Therefore, we need to instruct Netlify to rewrite all requests to serve the index.html. For this purpose, create netlify.toml file in the root directory of your project with the following content:

[[redirects]]
  from = "/*"
  to = "/index.html"
  status = 200

Test your deployment

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