GitXplorerGitXplorer
v

nextjs-optimizely-experimentation

public
21 stars
6 forks
1 issues

Commits

List of commits on branch main.
Unverified
8a590c16e6296e32a6f7dd715f950a9ce259a146

remove SSG

mmalewis5 committed 2 months ago
Unverified
4bc337ab8c35d700f4370555c0463d40efc15f6c

remove prefetch + change to cup not SSG

mmalewis5 committed 2 months ago
Unverified
50f2763fc521050e7989aba832a06478257cdf16

move to PPR

mmalewis5 committed 2 months ago
Unverified
0485b702d311d3a60e82f7b89ef7a6c42cd8603b

enable experimental flag

mmalewis5 committed 2 months ago
Verified
b0d8d2c5ed360c9e093fdf7c23eabd5475b5e33a

Merge pull request #1 from vercel/next-15

mmalewis5 committed 2 months ago
Unverified
c58b7a22650358fe192b0538471724d5e3e5c1ce

locked .yaml file

mmalewis5 committed 2 months ago

README

The README file for this repository.

Next.js and Optimizely Feature Experimentation

This is a Next.js template that integrates with Optimizely Feature Experimentation.

This project uses Next.js App Router and Partial Prerendering (PPR) to combine the benefits of static and dynamic rendering. This enables fast page loads to users with dynamic content and experiments. Optimizely experimentation data is saved to Vercel Edge Config through Optimizely webhooks which allows Edge Middleware and React Server Components (RSC) to perform decisions with minimal latency.

This project uses:

  • Next.js App Router
  • Partial Prerendering (PPR)
  • Vercel Edge Config
  • Edge Middleware
  • Tailwind CSS & shadcn/ui
  • Vercel Toolbar
  • Vercel Feature Flags
  • Optimizely Feature Experimentation

Deploy on Vercel

Deploy with Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Getting started

Sign up for a free Optimizely Feature Flags account and create a new project.

You must set the following environment variables to run this application:

  • OPTIMIZELY_API_KEY
  • OPTIMIZELY_SDK_KEY
  • OPTIMIZELY_PROJECT_ID
  • OPTIMIZELY_WEBHOOK_SECRET
  • API_TOKEN
  • TEAM_ID
  • EDGE_CONFIG
  • FLAGS_SECRET Create via: node -e "console.log(crypto.randomBytes(32).toString('base64url'))"

The Optimizely API key, SDK key, and Project ID are retrieved from your Optimizely Feature Experimentation project and account settings. The Optimizely webhook secret is created upon webhook creation. See the "Integrating Optimizely Webhooks with Vercel Edge Config" section below and Optimizely's Create Webhooks documentation for more details.

A Vercel API Token, Team ID, and Edge Config are required for storing experiment data in Vercel Edge Config. Refer to Creating an Access Token in Vercel's REST API documentation for creating your token, and Vercel Edge Config documentation for creating your Edge Config store.

Run the development server locally:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Integrating Optimizely Webhooks with Vercel Edge Config

This experimentation template uses Optimizely webhooks to sync experiment data to Vercel Edge Config. This allows experiment decisions to run in Edge Middleware and React Server Components with minimal latency.

To configure your Optimizely webhook:

  1. Navigate your browser to app.optimizely.com.
  2. Login and go to your Optimizely Feature Experimentation project settings.
  3. Select the "Webhooks" tab.
  4. Click "Create New Webhook".
  5. Provide a name for your webhook.
  6. Set the URL to the location of your Next.js Optimizely webhook route (https://[project domain]/api/.well-known/vercel/webhooks/optimizely).
  7. Under events, ensure the following events are selected:
    1. Datafile: Updated
    2. Flag: Created, Updated, Archived, Deleted
    3. Event: Created, Updated, Archived, Deleted
    4. Variable: Created, Updated, Archived, Deleted
    5. Variation: Created, Updated, Archived, Deleted
  8. Click "Save" and note the secret key generated for your webhook.
  9. Set your Vercel environment variable, OPTIMIZELY_WEBHOOK_SECRET, to the secret key.
  10. Once your webhook is created, create or update a flag in Optimizely to trigger the webhook and sync your experiment data to Vercel Edge Config.

Important files and folders

File(s) Description
/app/[code]/page.tsx Static homepage with dynamic segment for multiple variations
/app/product/[slug]/page.tsx Product detail page
/app/cart/page.tsx Cart page
/app/.well-known/vercel/flags/route.ts API route exposing flags to toolbar
/app/.well-known/vercel/webhooks/optimizely/route.ts API route called by optimizely to store experimentation data in Vercel Edge Config
/lib/actions.ts File containing server actions (e.g. track purchase event)
/lib/flags.ts Contains declared flags and precomputed flags
/middleware.ts Evaluates precomputed flags, set new shopper cookie
/lib/products.ts A hardcoded set of products

Learn More

Take a look at the following resources to learn more: