👉 Visit the DatoCMS homepage or see What is DatoCMS?

Next.js Starter Kit

This project aims to be a great starting point for your Next.js projects that need to interact with DatoCMS.

• 🔍 Fully commented code — Every file is commented and explained in detail, it will be impossible to get lost!
• 💯 100% TypeScript — Thanks to gql.tada every GraphQL query is fully typed, and your IDE will help you complete the GraphQL queries.
• 🛠️ Minimal boilerplate — The project is minimal and exposes only what is necessary to get started, without complicated models that need to be removed.
• 🚫 Zero CSS — There is only one CSS import, which you can remove to use your preferred CSS tool.
• 📝 Full support for Next.js Draft Mode — Your editors can always view the latest draft version of the content.
• 🧩 Plugin ready — Support for the fantastic plugins Web Previews and SEO/Readability Analysis.
• 🔄 DatoCMS's Real-time Updates API — Your editors can see updated content instantly as soon as you save a new version on DatoCMS.
• 🗑️ Cache invalidation — No need to re-deploy your website after each modification to your content, as it will be automatically updated thanks to DatoCMS webhooks.
• 🌐 SEO Metadata — Full integration between Next.js and the SEO settings coming from DatoCMS.

How to use

Quick start

1. Create an account on DatoCMS.

2. Make sure that you have set up the Github integration on Vercel.

3. Let DatoCMS set everything up for you clicking this button below:

Local setup

Once the setup of the project and repo is done, clone the repo locally.

Set up environment variables

Copy the sample .env file:

cp .env.local.example .env.local

In your DatoCMS' project, go to the Settings menu at the top and click API tokens.

Copy the values of the following tokens into the specified environment variable:

• DATOCMS_PUBLISHED_CONTENT_CDA_TOKEN: CDA Only (Published)
• DATOCMS_DRAFT_CONTENT_CDA_TOKEN: CDA Only (Draft)
• DATOCMS_CMA_TOKEN: CMA Only (Admin)

Then set SECRET_API_TOKEN as a sicure string — it will be used to safeguard all route handlers from incoming requests from untrusted sources.

Run your project locally

npm install
npm run dev

Your website should be up and running on http://localhost:3000!

VS Code

It is highly recommended to follow these instructions for an optimal experience with Visual Studio Code, including features like diagnostics, auto-completions, and type hovers for GraphQL.

Updating the GraphQL schema

When the DatoCMS schema, which includes various models and fields, undergoes any updates or modifications, it is essential to ensure that these changes are properly reflected in your local development environment. To accomplish this, you should locally run the following command:

npm run generate-schema

Executing this task will automatically update the schema.graphql file for you. This crucial step ensures that gql.tada will have access to the most current and accurate version of the GraphQL schema, allowing your application to function correctly with the latest data structures and relationships defined within your DatoCMS setup.

What is DatoCMS?

DatoCMS is the REST & GraphQL Headless CMS for the modern web.

Trusted by over 25,000 enterprise businesses, agency partners, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our developers, content editors and marketers!

Quick links:

• ⚡️ Get started with a free DatoCMS account
• 🔖 Go through the docs
• ⚙️ Get support from us and the community
• 🆕 Stay up to date on new features and fixes on the changelog

Our featured repos:

• datocms/react-datocms: React helper components for images, Structured Text rendering, and more
• datocms/js-rest-api-clients: Node and browser JavaScript clients for updating and administering your content. For frontend fetches, we recommend using our GraphQL Content Delivery API instead.
• datocms/cli: Command-line interface that includes our Contentful importer and Wordpress importer
• datocms/plugins: Example plugins we've made that extend the editor/admin dashboard
• DatoCMS Starters has examples for various Javascript frontend frameworks

Or see all our public repos