Installation

Before you start setting up the Experiences SDK, ensure that you have accomplished the setup in the Contentful web app: enable in a space(s) and configured Experiences. To learn more about the Experiences setup steps, refer to What are Experiences?.

React v18+
Contentful Javascript client library v10.6.0+
Web application must support being rendered in an iframe. If required by your CSP, add https://app.contentful.com into the list of allowed domains.

Studio is supported for React and some meta-frameworks that support React (such as Next.js).

The Experiences SDK supports all modern desktop browsers.

Install the SDK

Within your project folder, install the Experiences SDK and Contentful Javascript client library by running the following command:

npm install @contentful/experiences-sdk-react contentful

Next, follow the guide for your particular application to get started:

React for React applications that render on the client, like Create React App, Vite, or other single-page applications
Next.js for apps built with Next.js