This repository contains the packages and applications that form the Optimizely CMS Demo Site.
Make sure you're good to go, by:
- Requesting an Optimizely CMS instance using Sign-up for the program
- Ensure you have a GitHub account
- Ensuring you have (at least) a hobby plan account at Vercel, or are comfortable creating one
After signing up for the beta instance and provisioning of the instance, you'll get an e-mail with the keys and instructions to activate your account.
Follow these instructions to configure the CMS
After you've completed the CMS configuration instructions and collected the needed information, click the "Deploy to vercel" button below, to deploy this site to your Vercel Account
| Environment variable | Instruction |
|---|---|
| OPTIMIZELY_CMS_URL | The URL where the Optimizely CMS can be reached by the build process; for example: https://example.cms.optimizely.com/ |
| OPTIMIZELY_GRAPH_SECRET | The Content Graph Secret can be made visible on the CMS Dashboard, within the "Render Content" section. |
| OPTIMIZELY_GRAPH_APP_KEY | The Content Graph App key, which is shown on the CMS Dashboard, within the "Render Content" section. |
| OPTIMIZELY_GRAPH_SINGLE_KEY | The Content Graph Single key , which is shown on the CMS Dashboard, within the "Render Content" section. |
When the deployment has succeeded, the following steps are needed to enable "On Page Editing" or "In Context Editing".
Enable on-page / in context editing
Please refer to the Supported environment variables document for all supported configuration options for the frontend. The steps above only outine the mimimum required configuration to obtain a working demo site. Please note: every configuration change to the environment variables requires a new deployment to become active.
- Local development
- CMS Configuration
- Enable on-page / in context editing
- Supported environment variables
- Custom demo building
- General solution description
This project uses a mono-repository to hold both the main frontend application, as well as the supporting packages. The following packages are included in this repository:
| Package import | Short description | Documentation |
|---|---|---|
| @remkoj/optimizely-dxp-cli | Command line utitilities to work with the Optimizely CMS - SaaS Core and Content Graph | Available in the package README.md |
| @remkoj/optimizely-dxp-nextjs | Extensions for Next.JS and standard implementation components for Optimizely CMS - SaaS Core | Available in the package README.md |
| @remkoj/optimizely-dxp-react | React client components, with SSR support, to render content from Optimizely Content Graph | Available in the package README.md |
| @remkoj/optimizely-dxp-react-server | React server components, to render content from Optimizely Content Graph | Available in the package README.md |
| @remkoj/optimizely-graph-functions | GraphQL Codegen plugin to dynamically build functions that load the correct fields for each content item on a generic lookup. Used for the "getContentByPath" and "getContentById" methods of the sample site. | Available in the package README.md |
| @remkoj/optimizely-one-nextjs | React components (both client & server) to integrate the browser-side products from Optimizely (Web Experimentation, Data Platform & Content Analytics / Recommendations) | Available in the package README.md |