<!-- Thanks for opening a PR! Your contribution is much appreciated. In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change that you're making: --> This adds a new example under cms-dotcms/. Is a general-purpose example that should allow developers to undestand how to use next.js with dotCMS apis. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [x] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [x] Make sure the linting passes by running `pnpm lint` - [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: Daniel Esteves <estevesd8@gmail.com> Co-authored-by: Will Ezell <will@dotcms.com> Co-authored-by: Arcadio Quintero A <oidacra@gmail.com> Co-authored-by: Rafael <rjvelazco21@gmail.com>
6 KiB
A statically generated blog example using Next.js and GraphCMS
This example showcases Next.js's Static Generation feature using GraphCMS as the data source.
Demo
- Live: https://next-blog-graphcms.vercel.app/
- Preview Mode: https://next-blog-graphcms.vercel.app/api/preview...
https://next-blog-graphcms.vercel.app/
Related examples
- WordPress
- DatoCMS
- Sanity
- TakeShape
- Prismic
- Contentful
- Strapi
- Agility CMS
- Cosmic
- ButterCMS
- Storyblok
- Kontent
- Ghost
- Umbraco Heartcore
- Blog Starter
- Builder.io
- DotCMS
- Enterspeed
Deploy your own
Once you have access to the environment variables you'll need, deploy the example using Vercel:
How to use
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example cms-graphcms cms-graphcms-app
yarn create next-app --example cms-graphcms cms-graphcms-app
pnpm create next-app --example cms-graphcms cms-graphcms-app
Configuration
Step 1. Create an account and a project in GraphCMS
First, create an account in GraphCMS.
Step 2. Create a new GraphCMS project
After creating an account, create a new project from the Blog Starter template - be sure to include the example content.
Step 3. Set up environment variables
Copy the .env.local.example
file in this directory to .env.local
(which will be ignored by Git):
cp .env.local.example .env.local
Inside your project dashboard, navigate to Settings > API Access page.
Then set each variable in .env.local
:
GRAPHCMS_PROJECT_API
: Set it to the API endpoint under Endpoints, at the top of the page.GRAPHCMS_PROD_AUTH_TOKEN
: Copy theNEXT_EXAMPLE_CMS_GCMS_PROD_AUTH_TOKEN
token under Existing tokens, at the bottom of the page. This will only query content that is published.GRAPHCMS_DEV_AUTH_TOKEN
: Copy theNEXT_EXAMPLE_CMS_GCMS_DEV_AUTH_TOKEN
token under Existing tokens, at the bottom of the page. This will only query content that is in draft.GRAPHCMS_PREVIEW_SECRET
can be any random string (but avoid spaces), likeMY_SECRET
- this is used for Preview Mode.
Step 4. Run Next.js in development mode
npm install
npm run dev
# or
yarn install
yarn dev
Your blog should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
Step 5. Try preview mode
In GraphCMS, go to one of the posts in your project and:
- Update the title. For example, you can add
[Draft]
in front of the title. - After you edit the document save the article as a draft, but DO NOT click Publish. By doing this, the post will be in the draft stage.
Now, if you go to the post page on localhost, you won't see the updated title. However, if you use Preview Mode, you'll be able to see the change (Documentation).
To view the preview, transform the url to the following format: http://localhost:3000/api/preview?secret=<YOUR_SECRET_TOKEN>&slug=<SLUG_TO_PREVIEW>
where <YOUR_SECRET_TOKEN>
is the same secret you defined in the .env.local
file and <SLUG_TO_PREVIEW>
is the slug of one of the posts you want to preview.
You should now be able to see the updated title. To exit the preview mode, you can click on "Click here to exit preview mode" at the top.
Step 6. Deploy on Vercel
You can deploy this app to the cloud with Vercel (Documentation).
Deploy Your Local Project
To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.
Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local
file.
Deploy from Our Template
Alternatively, you can deploy using our template by clicking on the Deploy button below.