https://github.com/datocms/nextjs-starter-kit
https://github.com/datocms/nextjs-starter-kit
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/datocms/nextjs-starter-kit
- Owner: datocms
- Created: 2024-07-02T11:31:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T12:33:25.000Z (about 1 year ago)
- Last Synced: 2025-04-04T20:51:23.880Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://datocms-nextjs-starter-kit.vercel.app/
- Size: 39.1 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nextjs - Nextjs Starter Kit - This project aims to be a great starting point for your Next.js projects that need to interact with DatoCMS. (Starter)
README
👉 [Visit the DatoCMS homepage](https://www.datocms.com) or see [What is DatoCMS?](#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](https://gql-tada.0no.co/) 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](https://www.datocms.com/marketplace/plugins/i/datocms-plugin-web-previews) and [SEO/Readability Analysis](https://www.datocms.com/marketplace/plugins/i/datocms-plugin-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](https://datocms.com).
2. Make sure that you have set up the [Github integration on Vercel](https://vercel.com/docs/git/vercel-for-github).
3. Let DatoCMS set everything up for you clicking this button below:
[](https://dashboard.datocms.com/deploy?repo=datocms%2Fnextjs-starter-kit%3Amain)
### 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:
```bash
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 (you can use `openssl rand -hex 32` or any other cryptographically-secure random string generator). It will be used to safeguard all route handlers from incoming requests from untrusted sources:
#### Run your project locally
```bash
npm install
npm run dev
```
Your website should be up and running on [http://localhost:3000](http://localhost:3000)!
## VS Code
It is highly recommended to follow [these instructions](https://gql-tada.0no.co/get-started/installation#vscode-setup) 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.
## Next 14? But I want Next 15!
[Next 15 requires React 19](https://nextjs.org/docs/app/building-your-application/upgrading/version-15#react-19), which is currently in Release Candidate status as of today. Vercel aims to incorporate cutting-edge features in their releases, as this aligns with their vision for Next.js. To ensure maximum "production readiness," we advise exercising caution and waiting a bit longer before recommending that our users transition to React 19.
If you are inclined to experiment with the latest developments, you are welcome to begin with this starter and execute the codemods as outlined in the [Next 14 to 15 migration guide](https://nextjs.org/docs/app/building-your-application/upgrading/version-15#upgrading-from-14-to-15): we have tested this approach, and everything appears to function properly.
```
npx @next/codemod@canary upgrade latest
```
##
---
# What is DatoCMS?
[DatoCMS](https://www.datocms.com/) is the REST & GraphQL Headless CMS for the modern web.
Trusted by over 25,000 enterprise businesses, agencies, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our [developers](https://www.datocms.com/team/best-cms-for-developers), [content editors](https://www.datocms.com/team/content-creators) and [marketers](https://www.datocms.com/team/cms-digital-marketing)!
**Why DatoCMS?**
- **API-First Architecture**: Built for both REST and GraphQL, enabling flexible content delivery
- **Just Enough Features**: We believe in keeping things simple, and giving you [the right feature-set tools](https://www.datocms.com/features) to get the job done
- **Developer Experience**: First-class TypeScript support with powerful developer tools
**Getting Started:**
- ⚡️ [Create Free Account](https://dashboard.datocms.com/signup) - Get started with DatoCMS in minutes
- 🔖 [Documentation](https://www.datocms.com/docs) - Comprehensive guides and API references
- ⚙️ [Community Support](https://community.datocms.com/) - Get help from our team and community
- 🆕 [Changelog](https://www.datocms.com/product-updates) - Latest features and improvements
**Official Libraries:**
- [**Content Delivery Client**](https://github.com/datocms/cda-client) - TypeScript GraphQL client for content fetching
- [**REST API Clients**](https://github.com/datocms/js-rest-api-clients) - Node.js/Browser clients for content management
- [**CLI Tools**](https://github.com/datocms/cli) - Command-line utilities for schema migrations (includes [Contentful](https://github.com/datocms/cli/tree/main/packages/cli-plugin-contentful) and [WordPress](https://github.com/datocms/cli/tree/main/packages/cli-plugin-wordpress) importers)
**Official Framework Integrations**
Helpers to manage SEO, images, video and Structured Text coming from your DatoCMS projects:
- [**React Components**](https://github.com/datocms/react-datocms)
- [**Vue Components**](https://github.com/datocms/vue-datocms)
- [**Svelte Components**](https://github.com/datocms/datocms-svelte)
- [**Astro Components**](https://github.com/datocms/astro-datocms)
**Additional Resources:**
- [**Plugin Examples**](https://github.com/datocms/plugins) - Example plugins we've made that extend the editor/admin dashboard
- [**Starter Projects**](https://www.datocms.com/marketplace/starters) - Example website implementations for popular frameworks
- [**All Public Repositories**](https://github.com/orgs/datocms/repositories?q=&type=public&language=&sort=stargazers)