c1b753c795
### What? This PR adds the `cms-sitecore-xmcloud` example. Sitecore XM Cloud is a headless CMS platform that empowers content editors to manage content, layout, and structural aspects of web pages. The Sitecore JSS framework connects frontend JavaScript applications to the XM Cloud API, allowing retrieval of content and presentation layout information. Sitecore JSS for Next.js integrates Next.js with Sitecore JSS, offering a structured approach to connect a Next.js application to XM Cloud. The `cms-sitecore-xmcloud` example, derived from the Sitecore JSS initializer, showcases the frontend application exclusively, omitting backend implementation details. ### Why? While Sitecore offers detailed documentation for creating XM Cloud projects and JSS applications, existing starter templates often combine frontend and backend configurations. The `cms-sitecore-xmcloud` example focuses solely on the frontend application and includes environment variable examples to establish a connection with XM Cloud, eliminating the need for a .NET-compatible machine. ### How? For comprehensive guidance on setting up an XM Cloud site and JSS application, refer to Sitecore and Vercel documentation. The `cms-sitecore-xmcloud` example is created using the Sitecore JSS initializer, integrating Next.js and SXA (Sitecore Experience Accelerator) add-ons. Further documentation can be found at: - [Deploying to Vercel](https://doc.sitecore.com/xmc/en/developers/xm-cloud/walkthrough--deploying-your-front-end-application-to-vercel.html) - [Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html) - [Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html) - [Documentation (Create an XM Cloud project from a starter template)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/create-an-xm-cloud-project-from-a-starter-template-in-the-xm-cloud-deploy-app.html) Co-authored-by: Steven Tey <28986134+steven-tey@users.noreply.github.com> Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
60 lines
3 KiB
Text
60 lines
3 KiB
Text
# Read the Vercel + Sitecore docs for the full setup instructions: https://vercel.com/docs/integrations/sitecore
|
|
|
|
# For development purposes, note Next.js supports a .env.local
|
|
# file, which is already configured to be git ignored.
|
|
# Read more about Next.js support of environment variables here:
|
|
# https://nextjs.org/docs/basic-features/environment-variables
|
|
JSS_APP_NAME=
|
|
|
|
# The public URL to use for absolute URLs, which are required when
|
|
# the Next.js app is run within Sitecore editors.
|
|
# This should match the `serverSideRenderingEngineApplicationUrl`
|
|
# in your Sitecore configuration (see \sitecore\config\xmcloud-nextjs-starter.config).
|
|
# Be sure to update these values accordingly as your public endpoint changes.
|
|
# See https://jss.sitecore.com/docs/fundamentals/services/view-engine
|
|
PUBLIC_URL=http://localhost:3000
|
|
|
|
# To secure the Sitecore editor endpoint exposed by your Next.js app
|
|
# (`/api/editing/render` by default), a secret token is used. This (client-side)
|
|
# value must match your server-side value (see \sitecore\config\xmcloud-nextjs-starter.config).
|
|
# We recommend an alphanumeric value of at least 16 characters.
|
|
JSS_EDITING_SECRET=
|
|
|
|
# Your Sitecore API key is needed to build the app. Typically, the API key is
|
|
# defined in `scjssconfig.json` (as `sitecore.apiKey`). This file may not exist
|
|
# when building locally (if you've never run `jss setup`), or when building in a
|
|
# higher environment (since `scjssconfig.json` is ignored from source control).
|
|
# In this case, use this environment variable to provide the value at build time.
|
|
SITECORE_API_KEY=
|
|
|
|
# Your Sitecore API hostname is needed to build the app. Typically, the API host is
|
|
# defined in `scjssconfig.json` (as `sitecore.layoutServiceHost`). This file may
|
|
# not exist when building locally (if you've never run `jss setup`), or when building
|
|
# in a higher environment (since `scjssconfig.json` is ignored from source control).
|
|
# In this case, use this environment variable to provide the value at build time.
|
|
SITECORE_API_HOST=
|
|
|
|
# Your GraphQL Edge endpoint. This is required for Sitecore Experience Edge.
|
|
# For Sitecore XM, this is typically optional. By default, the endpoint is calculated using
|
|
# the resolved Sitecore API hostname + the `graphQLEndpointPath` defined in your `package.json`.
|
|
GRAPH_QL_ENDPOINT=
|
|
|
|
# Your default app language.
|
|
DEFAULT_LANGUAGE=
|
|
|
|
# The way in which layout and dictionary data is fetched from Sitecore
|
|
FETCH_WITH=GraphQL
|
|
|
|
# Indicates whether SSG `getStaticPaths` pre-render any pages
|
|
# Set the environment variable DISABLE_SSG_FETCH=true
|
|
# to enable full ISR (Incremental Static Regeneration) flow
|
|
DISABLE_SSG_FETCH=
|
|
|
|
# Sitecore JSS npm packages utilize the debug module for debug logging.
|
|
# https://www.npmjs.com/package/debug
|
|
# Set the DEBUG environment variable to 'sitecore-jss:*' to see all logs:
|
|
#DEBUG=sitecore-jss:*
|
|
# Or be selective and show for example only layout service logs:
|
|
#DEBUG=sitecore-jss:layout
|
|
# Or everything BUT layout service logs:
|
|
#DEBUG=sitecore-jss:*,-sitecore-jss:layout
|