diff --git a/docs/advanced-features/preview-mode.md b/docs/advanced-features/preview-mode.md index b0afff67050f3ac..c8dd261bbf69835 100644 --- a/docs/advanced-features/preview-mode.md +++ b/docs/advanced-features/preview-mode.md @@ -154,6 +154,7 @@ https:///api/preview?secret=&slug= Take a look at the following examples to learn more: - [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) ([Demo](https://next-blog-datocms.now.sh/)) +- [Sanity Example](https://github.com/zeit/next.js/tree/canary/examples/cms-sanity) ([Demo](https://next-blog-sanity.now.sh/)) ## More Details diff --git a/docs/basic-features/data-fetching.md b/docs/basic-features/data-fetching.md index c6624ff92a0d0cc..ea3d80cd5c8d759 100644 --- a/docs/basic-features/data-fetching.md +++ b/docs/basic-features/data-fetching.md @@ -489,6 +489,7 @@ Take a look at the following examples to learn more: - [Blog Starter using markdown files](https://github.com/zeit/next.js/tree/canary/examples/blog-starter) ([Demo](https://next-blog-starter.now.sh/)) - [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) ([Demo](https://next-blog-datocms.now.sh/)) +- [Sanity Example](https://github.com/zeit/next.js/tree/canary/examples/cms-sanity) ([Demo](https://next-blog-sanity.now.sh/)) ## Learn more diff --git a/docs/basic-features/pages.md b/docs/basic-features/pages.md index 204e73b9b8e0b51..4acc1a89f58a400 100644 --- a/docs/basic-features/pages.md +++ b/docs/basic-features/pages.md @@ -248,6 +248,7 @@ Take a look at the following examples to learn more: - [Blog Starter using markdown files](https://github.com/zeit/next.js/tree/canary/examples/blog-starter) ([Demo](https://next-blog-starter.now.sh/)) - [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) ([Demo](https://next-blog-datocms.now.sh/)) +- [Sanity Example](https://github.com/zeit/next.js/tree/canary/examples/cms-sanity) ([Demo](https://next-blog-sanity.now.sh/)) ## Learn more diff --git a/examples/blog-starter/README.md b/examples/blog-starter/README.md index 61bd1443e1d9a88..317abf28ea3393a 100644 --- a/examples/blog-starter/README.md +++ b/examples/blog-starter/README.md @@ -13,6 +13,7 @@ To create the blog posts we use [`remark`](https://github.com/remarkjs/remark) a ### Related examples - [DatoCMS](/examples/cms-datocms) +- [Sanity](/examples/cms-sanity) ## How to use diff --git a/examples/cms-datocms/README.md b/examples/cms-datocms/README.md index ebf82dd3149b4c4..fe945583f0fc897 100644 --- a/examples/cms-datocms/README.md +++ b/examples/cms-datocms/README.md @@ -9,6 +9,7 @@ This example showcases Next.js's [Static Generation](https://nextjs.org/docs/bas ### Related examples - [Blog Starter](/examples/blog-starter) +- [Sanity](/examples/cms-sanity) ## How to use diff --git a/examples/cms-sanity/.env.example b/examples/cms-sanity/.env.example new file mode 100644 index 000000000000000..443c7dde65a0d3c --- /dev/null +++ b/examples/cms-sanity/.env.example @@ -0,0 +1,3 @@ +NEXT_EXAMPLE_CMS_SANITY_PREVIEW_SECRET= +NEXT_EXAMPLE_CMS_SANITY_PROJECT_ID= +NEXT_EXAMPLE_CMS_SANITY_API_TOKEN= \ No newline at end of file diff --git a/examples/cms-sanity/.gitignore b/examples/cms-sanity/.gitignore new file mode 100644 index 000000000000000..5900fa96e8d3ebb --- /dev/null +++ b/examples/cms-sanity/.gitignore @@ -0,0 +1,2 @@ +.env +.now \ No newline at end of file diff --git a/examples/cms-sanity/README.md b/examples/cms-sanity/README.md new file mode 100644 index 000000000000000..34de358f566bb15 --- /dev/null +++ b/examples/cms-sanity/README.md @@ -0,0 +1,159 @@ +# A statically generated blog example using Next.js and Sanity + +This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using [Sanity](https://www.sanity.io/) as the data source. + +## Demo + +### [https://next-blog-sanity.now.sh/](https://next-blog-sanity.now.sh/) + +### Related examples + +- [Blog Starter](/examples/blog-starter) +- [DatoCMS](/examples/cms-datocms) + +## How to use + +### Using `create-next-app` + +Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: + +```bash +npm init next-app --example cms-sanity cms-sanity-app +# or +yarn create next-app --example cms-sanity cms-sanity-app +``` + +### Download manually + +Download the example: + +```bash +curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/cms-sanity +cd cms-sanity +``` + +## Configuration + +### Step 1. Create an account and a project on Sanity + +First, [create an account on Sanity](https://sanity.io). + +After creating an account, install the Sanity cli from npm `npm i -g @sanity/cli`. + +### Step 2. Create a new Sanity project + +In a separate folder run `sanity init` to initialize a new studio project. + +This will be where we manage our data. + +When going through the init phase make sure to select **Yes** to the **Use the default dataset configuration** step and select **Clean project with no predefined schemas** for the **Select project template** step. + +### Step 3. Generate an API token + +Log into https://manage.sanity.io/ and choose the project you just created. Then from **Settings**, select **API**, then click **Add New Token** and create a token with the **Read** permission. + +### Step 4. Set up environment variables + +Copy the `.env.example` file in this directory to `.env` (which will be ignored by Git): + +```bash +cp .env.example .env +``` + +Then set each variable on `.env`: + +- `NEXT_EXAMPLE_CMS_SANITY_PREVIEW_SECRET` can be any random string (but avoid spaces), like `MY_SECRET` - this is used for [the Preview Mode](/docs/advanced-features/preview-mode.md). +- `NEXT_EXAMPLE_CMS_SANITY_PROJECT_ID`: Get the `projectId` value from the `sanity.json` file created in step 2. +- `NEXT_EXAMPLE_CMS_SANITY_API_TOKEN`: Copy the API token generated in the previous step. + +Your `.env` file should look like this: + +```bash +NEXT_EXAMPLE_CMS_SANITY_PREVIEW_SECRET=... +NEXT_EXAMPLE_CMS_SANITY_PROJECT_ID=... +NEXT_EXAMPLE_CMS_SANITY_API_TOKEN=... +``` + +### Step 5. Prepare project for previewing + +Go to https://www.sanity.io/docs/preview-content-on-site and follow the three steps on that page. It should be done inside the studio project generated in Step 2. + +When you get to the second step about creating a file called `resolveProductionUrl.js`, copy the following instead: + +```js +const previewSecret = 'MY_SECRET' // Copy the string you used for NEXT_EXAMPLE_CMS_SANITY_PREVIEW_SECRET +const projectUrl = 'http://localhost:3000' + +export default function resolveProductionUrl(document) { + return `${projectUrl}/api/preview?secret=${previewSecret}&slug=${document.slug.current}` +} +``` + +### Step 6. Copy the schema file + +After initializing your Sanity studio project there should be a `schemas` folder. + +Replace the contents of `schema.js` in the Sanity studio project directory with [`./schemas/schema.js`](./schemas/schema.js) in this example directory. This will set up the schema we’ll use this for this example. + +### Step 7. Populate Content + +To add some content go to your Sanity studio project directory and run `sanity start`. + +After the project has started and you have navigated to the URL given in the terminal, select **Author** and create a new record. + +- You just need **1 Author record**. +- Use dummy data for the text. +- For the image, you can download one from [Unsplash](https://unsplash.com/). + +Next, select **Post** and create a new record. + +- We recommend creating at least **2 Post records**. +- Use dummy data for the text. +- You can write markdown for the **Content** field. +- For the images, you can download ones from [Unsplash](https://unsplash.com/). +- Pick the **Author** you created earlier. + +**Important:** For each post record, you need to click **Publish** after saving. If not, the post will be in the draft state. + +### Step 8. Run Next.js in development mode + +```bash +npm install +npm run dev + +# or + +yarn install +yarn 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/zeit/next.js/discussions). + +### Step 9. Try preview mode + +On Sanity, go to one of the posts you've created and: + +- **Update the title**. For example, you can add `[Draft]` in front of the title. +- As you edit the document it will be saved as a draft, but **DO NOT** click **Publish**. By doing this, the post will be in the draft state. + +Now, if you go to the post page on localhost, you won't see the updated title. However, if you use the **Preview Mode**, you'll be able to see the change ([Documentation](/docs/advanced-features/preview-mode.md)). + +To view the preview, go to the post edit page on Sanity, click the three dots above the document and select **Open preview** ([see the instruction here](https://www.sanity.io/docs/preview-content-on-site)) + +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 10. Deploy on ZEIT Now + +You can deploy this app to the cloud with [ZEIT Now](https://zeit.co/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). + +To deploy on ZEIT Now, you need to set the environment variables with **Now Secrets** using [Now CLI](https://zeit.co/download) ([Documentation](https://zeit.co/docs/now-cli#commands/secrets)). + +Install [Now CLI](https://zeit.co/download), log in to your account from the CLI, and run the following commands to add the environment variables. Replace each variable with the corresponding strings in `.env`. + +``` +now secrets add next_example_cms_sanity_preview_secret +now secrets add next_example_cms_sanity_api_token +now secrets add next_example_cms_sanity_project_id +``` + +Then push the project to GitHub/GitLab/Bitbucket and [import to ZEIT Now](https://zeit.co/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) to deploy. diff --git a/examples/cms-sanity/components/alert.js b/examples/cms-sanity/components/alert.js new file mode 100644 index 000000000000000..74b887c1a0460f9 --- /dev/null +++ b/examples/cms-sanity/components/alert.js @@ -0,0 +1,42 @@ +import Container from './container' +import cn from 'classnames' +import { EXAMPLE_PATH } from '../lib/constants' + +export default function Alert({ preview }) { + return ( +
+ +
+ {preview ? ( + <> + This page is a preview.{' '} + + Click here + {' '} + to exit preview mode. + + ) : ( + <> + The source code for this blog is{' '} + + available on GitHub + + . + + )} +
+ +
+ ) +} diff --git a/examples/cms-sanity/components/avatar.js b/examples/cms-sanity/components/avatar.js new file mode 100644 index 000000000000000..2dcc7eee1069383 --- /dev/null +++ b/examples/cms-sanity/components/avatar.js @@ -0,0 +1,8 @@ +export default function Avatar({ name, picture }) { + return ( +
+ {name} +
{name}
+
+ ) +} diff --git a/examples/cms-sanity/components/container.js b/examples/cms-sanity/components/container.js new file mode 100644 index 000000000000000..fc1c29dfb074756 --- /dev/null +++ b/examples/cms-sanity/components/container.js @@ -0,0 +1,3 @@ +export default function Container({ children }) { + return
{children}
+} diff --git a/examples/cms-sanity/components/cover-image.js b/examples/cms-sanity/components/cover-image.js new file mode 100644 index 000000000000000..91a4a56c01448a0 --- /dev/null +++ b/examples/cms-sanity/components/cover-image.js @@ -0,0 +1,33 @@ +import cn from 'classnames' +import Link from 'next/link' +import { imageBuilder } from '../lib/api' + +export default function CoverImage({ title, url, slug }) { + const image = ( + {`Cover + ) + + return ( +
+ {slug ? ( + + {image} + + ) : ( + image + )} +
+ ) +} diff --git a/examples/cms-sanity/components/date.js b/examples/cms-sanity/components/date.js new file mode 100644 index 000000000000000..eac5681378bfd4f --- /dev/null +++ b/examples/cms-sanity/components/date.js @@ -0,0 +1,6 @@ +import { parseISO, format } from 'date-fns' + +export default function Date({ dateString }) { + const date = parseISO(dateString) + return +} diff --git a/examples/cms-sanity/components/footer.js b/examples/cms-sanity/components/footer.js new file mode 100644 index 000000000000000..dbde8ff306efdbf --- /dev/null +++ b/examples/cms-sanity/components/footer.js @@ -0,0 +1,30 @@ +import Container from './container' +import { EXAMPLE_PATH } from '../lib/constants' + +export default function Footer() { + return ( + + ) +} diff --git a/examples/cms-sanity/components/header.js b/examples/cms-sanity/components/header.js new file mode 100644 index 000000000000000..562e7e3eebb6a00 --- /dev/null +++ b/examples/cms-sanity/components/header.js @@ -0,0 +1,12 @@ +import Link from 'next/link' + +export default function Header() { + return ( +

+ + Blog + + . +

+ ) +} diff --git a/examples/cms-sanity/components/hero-post.js b/examples/cms-sanity/components/hero-post.js new file mode 100644 index 000000000000000..1aab163fa30eab6 --- /dev/null +++ b/examples/cms-sanity/components/hero-post.js @@ -0,0 +1,37 @@ +import Avatar from '../components/avatar' +import Date from '../components/date' +import CoverImage from '../components/cover-image' +import Link from 'next/link' + +export default function HeroPost({ + title, + coverImage, + date, + excerpt, + author, + slug, +}) { + return ( +
+
+ +
+
+
+

+ + {title} + +

+
+ +
+
+
+

{excerpt}

+ +
+
+
+ ) +} diff --git a/examples/cms-sanity/components/intro.js b/examples/cms-sanity/components/intro.js new file mode 100644 index 000000000000000..5931b3c5961bdbb --- /dev/null +++ b/examples/cms-sanity/components/intro.js @@ -0,0 +1,28 @@ +import { CMS_NAME, CMS_URL } from '../lib/constants' + +export default function Intro() { + return ( +
+

+ Blog. +

+

+ A statically generated blog example using{' '} + + Next.js + {' '} + and{' '} + + {CMS_NAME} + + . +

+
+ ) +} diff --git a/examples/cms-sanity/components/layout.js b/examples/cms-sanity/components/layout.js new file mode 100644 index 000000000000000..99d95353131e0fa --- /dev/null +++ b/examples/cms-sanity/components/layout.js @@ -0,0 +1,16 @@ +import Alert from '../components/alert' +import Footer from '../components/footer' +import Meta from '../components/meta' + +export default function Layout({ preview, children }) { + return ( + <> + +
+ +
{children}
+
+