Contentful Personalization & Analytics

Node SSR Only Reference Implementation

This is a reference implementation for the Optimization Node SDK and is part of the Contentful Optimization SDK Suite.

The server creates one stateless Node SDK instance at module load and passes request-specific options directly to stateless event methods inside each incoming request handler.

What this demonstrates

Use this implementation when you need a minimal server-rendered example for @contentful/optimization-node. It demonstrates request-scoped Experience API options, SSR-safe entry resolution, merge-tag rendering, profile-aware event calls, and local mock API usage.

Prerequisites

• Node.js >= 20.19.0 (24.13.0 recommended to match .nvmrc)
• pnpm 10.x

Setup

Run all steps from the monorepo root.

1. Install pnpm packages:

   pnpm install
   Copy

2. Build the local package tarballs consumed by implementations:

   pnpm build:pkgs
   Copy

3. Install this implementation so its local @contentful/* dependencies resolve from pkgs/:

   pnpm implementation:run -- node-sdk implementation:install
   Copy

4. Configure the environment in a .env file in implementations/node-sdk based on the .env.example included file. The file is pre-populated with values that are valid only against the mock server implementation. To test the implementation against a live server environment, see the mocks package for information on how to set up Contentful space with test data.

Running locally

Run these commands from the monorepo root.

1. Start servers:

   pnpm implementation:run -- node-sdk serve
   Copy

2. Stop servers:

   pnpm implementation:run -- node-sdk serve:stop
   Copy

3. Run E2E:

   pnpm test:e2e:node-sdk
   Copy

The application can be accessed via Web browser at http://localhost:3000. See implementations/node-sdk/package.json for lower-level local commands.

Running E2E tests

E2E tests are run using Playwright.

1. Install implementation dependencies, browser binaries, and system dependencies:

   pnpm setup:e2e:node-sdk
   Copy

2. Run the E2E test suite:

   pnpm test:e2e:node-sdk
   Copy

   The tests can alternatively be run using Playwright's GUI:

   pnpm implementation:run -- node-sdk test:e2e:ui
   Copy

Related

• @contentful/optimization-node - Node SDK package
• Node SSR + Web Vanilla - Hybrid server/browser reference implementation
• Mocks package - Shared mock API server and fixtures