| # A statically generated blog example using Next.js and Sanity |
|
|
|  |
|
|
| This starter is a statically generated blog that uses Next.js App Router for the frontend and [Sanity][sanity-homepage] to handle its content. It comes with a native Sanity Studio that offers features like real-time collaboration and visual editing with live updates using [Presentation][presentation]. |
|
|
| The Studio connects to Sanity Content Lake, which gives you hosted content APIs with a flexible query language, on-demand image transformations, powerful patching, and more. You can use this starter to kick-start a blog or learn these technologies. |
|
|
| ## Features |
|
|
| - A performant, static blog with editable posts, authors, and site settings |
| - TypeScript setup with [Sanity TypeGen](https://www.sanity.io/docs/sanity-typegen) |
| - A native and customizable authoring environment, accessible on `yourblog.com/studio` |
| - Real-time and collaborative content editing with fine-grained revision history |
| - Side-by-side instant content preview that works across your whole site |
| - Support for block content and the most advanced custom fields capability in the industry |
| - Incremental Static Revalidation; no need to wait for a rebuild to publish new content |
| - Unsplash integration setup for easy media management |
| - [Sanity AI Assist preconfigured for image alt text generation](https://www.sanity.io/docs/ai-assist?utm_source=github.com&utm_medium=organic_social&utm_campaign=ai-assist&utm_content=) |
| - Out of the box support for [Vercel Visual Editing](https://www.sanity.io/blog/visual-editing-sanity-vercel?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch). |
|
|
| ## Demo |
|
|
| ### [https://next-blog.sanity.build](https://next-blog.sanity.build) |
|
|
| ## Deploy your own |
|
|
| Use the Deploy Button below, you'll deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) as well as connect it to your Sanity dataset using [the Sanity Vercel Integration][integration]. |
|
|
| [][vercel-deploy] |
|
|
| ## How to use |
|
|
| Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example: |
|
|
| ```bash |
| npx create-next-app --example cms-sanity next-sanity-blog |
| ``` |
|
|
| ```bash |
| yarn create next-app --example cms-sanity next-sanity-blog |
| ``` |
|
|
| ```bash |
| pnpm create next-app --example cms-sanity next-sanity-blog |
| ``` |
|
|
| Whenever you edit a GROQ query you update the TypeScript types by running: |
|
|
| ```bash |
| npm run typegen |
| ``` |
|
|
| # Configuration |
|
|
| - [Step 1. Set up the environment](#step-1-set-up-the-environment) |
| - [Reuse remote environment variables](#reuse-remote-environment-variables) |
| - [Using the Sanity CLI](#using-the-sanity-cli) |
| - [Creating a read token](#creating-a-read-token) |
| - [Step 2. Run Next.js locally in development mode](#step-2-run-nextjs-locally-in-development-mode) |
| - [Step 3. Populate content](#step-3-populate-content) |
| - [Step 4. Deploy to production](#step-4-deploy-to-production) |
| - [Next steps](#next-steps) |
|
|
| ## Step 1. Set up the environment |
|
|
| ### Reuse remote environment variables |
|
|
| If you started with [deploying your own](#deploy-your-own) then you can run this to reuse the environment variables from the Vercel project and skip to the next step: |
|
|
| ```bash |
| npx vercel link |
| npx vercel env pull |
| ``` |
|
|
| ### Using the Sanity CLI |
|
|
| Copy the `.env.local.example` file to `.env.local` to get started: |
|
|
| ```bash |
| cp -i .env.local.example .env.local |
| ``` |
|
|
| Run the setup command to get setup with a Sanity project, dataset and their relevant environment variables: |
|
|
| ```bash |
| npm run setup |
| ``` |
|
|
| ```bash |
| yarn setup |
| ``` |
|
|
| ```bash |
| pnpm run setup |
| ``` |
|
|
| You'll be asked multiple questions, here's a sample output of what you can expect: |
|
|
| ```bash |
| Need to install the following packages: |
| sanity@3.30.1 |
| Ok to proceed? (y) y |
| You're setting up a new project! |
| We'll make sure you have an account with Sanity.io. |
| Press ctrl + C at any time to quit. |
| |
| Prefer web interfaces to terminals? |
| You can also set up best practice Sanity projects with |
| your favorite frontends on https://www.sanity.io/templates |
| |
| Looks like you already have a Sanity-account. Sweet! |
| |
| ✔ Fetching existing projects |
| ? Select project to use Templates [r0z1eifg] |
| ? Select dataset to use blog-vercel |
| ? Would you like to add configuration files for a Sanity project in this Next.js folder? No |
| |
| Detected framework Next.js, using prefix 'NEXT_PUBLIC_' |
| Found existing NEXT_PUBLIC_SANITY_PROJECT_ID, replacing value. |
| Found existing NEXT_PUBLIC_SANITY_DATASET, replacing value. |
| ``` |
|
|
| It's important that when you're asked `Would you like to add configuration files for a Sanity project in this Next.js folder?` that you answer `No` as this example is already setup with the required configuration files. |
|
|
| #### Creating a read token |
|
|
| This far your `.env.local` file should have values for `NEXT_PUBLIC_SANITY_PROJECT_ID` and `NEXT_PUBLIC_SANITY_DATASET`. |
| Before you can run the project you need to setup a read token (`SANITY_API_READ_TOKEN`), it's used for authentication when Sanity Studio is live previewing your application. |
|
|
| 1. Go to [manage.sanity.io](https://manage.sanity.io/) and select your project. |
| 2. Click on the `🔌 API` tab. |
| 3. Click on `+ Add API token`. |
| 4. Name it "next blog live preview read token" and set `Permissions` to `Viewer` and hit `Save`. |
| 5. Copy the token and add it to your `.env.local` file. |
|
|
| ```bash |
| SANITY_API_READ_TOKEN="<paste your token here>" |
| ``` |
|
|
| Your `.env.local` file should look something like this: |
|
|
| ```bash |
| NEXT_PUBLIC_SANITY_PROJECT_ID="r0z1eifg" |
| NEXT_PUBLIC_SANITY_DATASET="blog-vercel" |
| SANITY_API_READ_TOKEN="sk..." |
| ``` |
|
|
| > [!CAUTION] |
| > Make sure to add `.env.local` to your `.gitignore` file so you don't accidentally commit it to your repository. |
|
|
| ## Step 2. Run Next.js locally in development mode |
|
|
| ```bash |
| npm install && npm run dev |
| ``` |
|
|
| ```bash |
| yarn install && yarn dev |
| ``` |
|
|
| ```bash |
| pnpm install && pnpm dev |
| ``` |
|
|
| Your blog should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions). |
|
|
| ## Step 3. Populate content |
|
|
| Open your Sanity Studio that should be running on [http://localhost:3000/studio](http://localhost:3000/studio). |
|
|
| By default you're taken to the [Presentation tool][presentation], which has a preview of the blog on the left hand side, and a list of documents on the right hand side. |
|
|
| <details> |
| <summary>View screenshot ✨</summary> |
|
|
|  |
|
|
| </details> |
|
|
| We're all set to do some content creation! |
|
|
| - Click on the **"+ Create"** button top left and select **Post** |
| - Type some dummy data for the **Title** |
| - **Generate** a **Slug** |
| <details> |
| <summary>Now that you have a slug you should see the post show up in the preview on the left hand side ✨</summary> |
|
|
|  |
|
|
| </details> |
|
|
| - Fill in **Content** with some dummy text |
| <details> |
| <summary>Or generate it with AI Assist ✨</summary> |
|
|
| If you've enabled [AI Assist][enable-ai-assist] you click on the sparkles ✨ button and generate a draft based on your title and then on **Generate sample content**. |
|
|
|  |
|
|
| </details> |
|
|
| - Summarize the **Content** in the **Excerpt** field |
| <details> |
| <summary>Or have AI Assist summarize it for you ✨</summary> |
|
|
| If you've enabled [AI Assist][enable-ai-assist] you click on the sparkles ✨ button and then on **Generate sample content**. |
|
|
|  |
|
|
| </details> |
|
|
| - Select a **Cover Image** from [Unsplash]. |
| <details> |
| <summary>Unsplash is available in the **Select** dropdown ✨</summary> |
|
|
|  |
|
|
| </details> |
| <details> |
| <summary>Click the "Crop image" button to adjust hotspots and cropping ✨</summary> |
|
|
|  |
|
|
| </details> |
| <details> |
| <summary>You can preview the results live on the left side, and additional formats on the right side ✨</summary> |
|
|
|  |
|
|
| </details> |
|
|
| - Customize the blog name, description and more. |
| <details> |
| <summary>Click "Structure" at the top center, then on "Settings" on the left hand side ✨</summary> |
|
|
|  |
|
|
| </details> |
| <details> |
| <summary>Once you have a "Settings" document, you can customize it inside "Presentation" ✨</summary> |
|
|
|  |
|
|
| </details> |
|
|
| > [!IMPORTANT] |
| > For each post record, you need to click **Publish** after saving for it to be visible outside Draft Mode. In production new content is using [Time-based Revalidation](https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#time-based-revalidation), which means it may take up to 1 minute before changes show up. Since a stale-while-revalidate pattern is used you may need to refresh a couple of times to see the changes. |
|
|
| ## Step 4. Deploy to production |
|
|
| > [!NOTE] |
| > If you already [deployed with Vercel earlier](#deploy-your-own) you can skip this step. |
|
|
| To deploy your local project to Vercel, push it to [GitHub](https://docs.github.com/en/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github)/GitLab/Bitbucket and [import to Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example). |
|
|
| > [!IMPORTANT] |
| > When you import your project on Vercel, make sure to click on **Environment Variables** and set them to match your `.env.local` file. |
|
|
| After it's deployed link your local code to the Vercel project: |
|
|
| ```bash |
| npx vercel link |
| ``` |
|
|
| > [!TIP] |
| > In production you can exit Draft Mode by clicking on _"Back to published"_ at the top. On [Preview deployments](https://vercel.com/docs/deployments/preview-deployments) you can [toggle Draft Mode in the Vercel Toolbar](https://vercel.com/docs/workflow-collaboration/draft-mode#enabling-draft-mode-in-the-vercel-toolbar). |
|
|
| ## Next steps |
|
|
| - [Join the Sanity community](https://slack.sanity.io/) |
|
|
| ## Related examples |
|
|
| - [AgilityCMS](/examples/cms-agilitycms) |
| - [Builder.io](/examples/cms-builder-io) |
| - [ButterCMS](/examples/cms-buttercms) |
| - [Contentful](/examples/cms-contentful) |
| - [Cosmic](/examples/cms-cosmic) |
| - [DatoCMS](/examples/cms-datocms) |
| - [DotCMS](/examples/cms-dotcms) |
| - [Drupal](/examples/cms-drupal) |
| - [Enterspeed](/examples/cms-enterspeed) |
| - [Ghost](/examples/cms-ghost) |
| - [GraphCMS](/examples/cms-graphcms) |
| - [Kontent.ai](/examples/cms-kontent-ai) |
| - [MakeSwift](/examples/cms-makeswift) |
| - [Payload](/examples/cms-payload) |
| - [Plasmic](/examples/cms-plasmic) |
| - [Prepr](/examples/cms-prepr) |
| - [Prismic](/examples/cms-prismic) |
| - [Sanity](/examples/cms-sanity) |
| - [Sitecore XM Cloud](/examples/cms-sitecore-xmcloud) |
| - [Sitefinity](/examples/cms-sitefinity) |
| - [Storyblok](/examples/cms-storyblok) |
| - [TakeShape](/examples/cms-takeshape) |
| - [Tina](/examples/cms-tina) |
| - [Umbraco](/examples/cms-umbraco) |
| - [Umbraco heartcore](/examples/cms-umbraco-heartcore) |
| - [Webiny](/examples/cms-webiny) |
| - [WordPress](/examples/cms-wordpress) |
| - [Blog Starter](/examples/blog-starter) |
|
|
| [vercel-deploy]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fcms-sanity&repository-name=cms-sanity&project-name=cms-sanity&demo-title=Blog%20using%20Next.js%20%26%20Sanity&demo-description=Real-time%20updates%2C%20seamless%20editing%2C%20no%20rebuild%20delays.&demo-url=https%3A%2F%2Fnext-blog.sanity.build%2F&demo-image=https%3A%2F%2Fgithub.com%2Fsanity-io%2Fnext-sanity%2Fassets%2F81981%2Fb81296a9-1f53-4eec-8948-3cb51aca1259&integration-ids=oac_hb2LITYajhRQ0i4QznmKH7gx |
| [integration]: https://www.sanity.io/docs/vercel-integration |
| [`.env.local.example`]: .env.local.example |
| [unsplash]: https://unsplash.com |
| [sanity-homepage]: https://www.sanity.io?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter |
| [presentation]: https://www.sanity.io/docs/presentation |
| [enable-ai-assist]: https://www.sanity.io/plugins/ai-assist#enabling-the-ai-assist-api |
|
|
