Click the deploy button below to directly deploy this repository with Vercel
This is a Next.js project bootstrapped
with create-next-app.
When deploying to Vercel add the environment variables listed below, if you use the "Deploy with vercel" button the
names of the variables are pre-populated for you.
| Variable | Description | Default Value |
|---|---|---|
| CG_ENDPOINT | Content Graph Endpoint to use | https://cg.optimizely.com/content/v2 |
| CG_SINGLE_KEY | Single Key from Content Graph | |
| CG_APP_KEY | App Key from ContentGraph | |
| CG_SECRET | App Secret from ContentGraph | |
| CG_WEBHOOK_SECRET | The secret used when registering the webhook with Content Graph | |
| CMS_URL | The url of your CMS that will be used when using visual-editing on a preview branch |
The BlocksTypes and Blocks required to run this frontend application can be found in cms/TheCityGuide.episerverdata. You can import them into your instance of Optimizely CMS with the Import/Export Data functionality. More information can be found here - https://support.optimizely.com/hc/en-us/articles/4413192300301-Export-and-import-data
npm run generate-local
# or
yarn generate-local
# or
pnpm generate-local You can run also run yarn generate-local -w to watch your ./src/graphql folder for changes to .graphql files and
auto-update the generate typescript files automatically.
codegen.yaml controls what plugins are used to generate the typescript bindings. More information on how the codegen plugin works can be found here - https://the-guild.dev/graphql/codegen
The template makes use of Content Graph Webhooks functionality to invalidate the changes when someone makes changes on the CMS https://docs.developers.optimizely.com/digital-experience-platform/v1.4.0-content-graph/docs/webhooks
The invalidation logic is located in src/app/api/revalidate/route.ts
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
API routes can be accessed
on http://localhost:3000/api/hello. This endpoint can be edited
in pages/api/hello.ts.
The app/api directory is mapped to /api/*. Files in this directory are treated
as API routes instead of React pages.
This project uses next/font to automatically optimize
and
load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and
contributions
are welcome!