Contentful Personalization & Analytics

Warning

The Optimization SDK Suite is pre-release (alpha). Breaking changes may be published at any time.

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

Setup

All steps should be run from the monorepo root.

Install pnpm packages:
```
pnpm install
```
Build the local package tarballs consumed by implementations:
```
pnpm build:pkgs
```
Install this implementation so its local @contentful/* dependencies resolve from pkgs/:
```
pnpm implementation:run -- web-sdk implementation:install
```
Configure the environment in a .env file in implementations/web-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.

Start the mock API and application servers:

pnpm --dir implementations/web-sdk --ignore-workspace serve

Stop the mock API and application servers:

pnpm --dir implementations/web-sdk --ignore-workspace serve:stop

See implementations/web-sdk/package.json for more commands.

You can run this implementation from the monorepo root via the root package.json implementation scripts.

Start servers:

pnpm run implementation:web-sdk -- serve

Stop servers:

pnpm run implementation:web-sdk -- serve:stop

Run E2E:

pnpm run implementation:web-sdk -- test:e2e

E2E tests are run using Playwright.

Install Playwright dependencies:

pnpm --dir implementations/web-sdk --ignore-workspace exec playwright install --with-deps

Run the E2E test suite:

pnpm --dir implementations/web-sdk --ignore-workspace test:e2e

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

pnpm --dir implementations/web-sdk --ignore-workspace test:e2e:ui