diff --git a/docs/advanced-features/preview-mode.md b/docs/advanced-features/preview-mode.md index d15b3d8229a0..a5ef1e901e06 100644 --- a/docs/advanced-features/preview-mode.md +++ b/docs/advanced-features/preview-mode.md @@ -149,6 +149,12 @@ That’s it! If you access the preview API route (with `secret` and `slug`) from https:///api/preview?secret=&slug= ``` +## More Examples + +Take a look at the following examples to learn more: + +- [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) + ## More Details ### Clear the preview mode cookies diff --git a/docs/basic-features/data-fetching.md b/docs/basic-features/data-fetching.md index 36efd64056ff..c3f5053cd529 100644 --- a/docs/basic-features/data-fetching.md +++ b/docs/basic-features/data-fetching.md @@ -424,6 +424,12 @@ function Profile() { [Check out the SWR documentation to learn more](https://swr.now.sh/). +## More Examples + +Take a look at the following examples to learn more: + +- [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) + ## Learn more We recommend you to read the following sections next: diff --git a/docs/basic-features/pages.md b/docs/basic-features/pages.md index 6949549946c9..01142aee742d 100644 --- a/docs/basic-features/pages.md +++ b/docs/basic-features/pages.md @@ -242,6 +242,12 @@ We've discussed two forms of pre-rendering for Next.js. - **Static Generation (Recommended):** The HTML is generated at **build time** and will be reused on each request. To make a page use Static Generation, just export the page component, or export `getStaticProps` (and `getStaticPaths` if necessary). It's great for pages that can be pre-rendered ahead of a user's request. You can also use it with Client-side Rendering to bring in additional data. - **Server-side Rendering:** The HTML is generated on **each request**. To make a page use Server-side Rendering, export `getServerSideProps`. Because Server-side Rendering results in slower performance than Static Generation, use this only if absolutely necessary. +## More Examples + +Take a look at the following examples to learn more: + +- [DatoCMS Example](https://github.com/zeit/next.js/tree/canary/examples/cms-datocms) + ## Learn more We recommend you to read the following sections next: diff --git a/examples/cms-datocms/.env.example b/examples/cms-datocms/.env.example new file mode 100644 index 000000000000..ae251bfdff7e --- /dev/null +++ b/examples/cms-datocms/.env.example @@ -0,0 +1,2 @@ +NEXT_EXAMPLE_CMS_DATOCMS_API_TOKEN= +NEXT_EXAMPLE_CMS_DATOCMS_PREVIEW_SECRET= \ No newline at end of file diff --git a/examples/cms-datocms/.gitignore b/examples/cms-datocms/.gitignore new file mode 100644 index 000000000000..5900fa96e8d3 --- /dev/null +++ b/examples/cms-datocms/.gitignore @@ -0,0 +1,2 @@ +.env +.now \ No newline at end of file diff --git a/examples/cms-datocms/README.md b/examples/cms-datocms/README.md new file mode 100644 index 000000000000..0dffcfa1d8b4 --- /dev/null +++ b/examples/cms-datocms/README.md @@ -0,0 +1,153 @@ +# A statically generated blog example using Next.js and DatoCMS + +This example showcases Next.js's [Static Generation](/docs/basic-features/pages.md) feature using [DatoCMS](https://www.datocms.com/) as the data source. + +## 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-datocms cms-datocms-app +# or +yarn create next-app --example cms-datocms cms-datocms-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-datocms +cd cms-datocms +``` + +## Configuration + +### Step 1. Create an account and a project on DatoCMS + +First, [create an account on DatoCMS](https://datocms.com). + +After creating an account, create a **new project** from the dashboard. You can select a **Blank Project**. + +### Step 2. Create an `Author` model + +From the project setting page, create a new **Model**. + +- The name should be `Author`. + +Next, add these fields (you don't have to modify the settings): + +- `Name` - **Text** field (**Single-line String**) +- `Picture` - **Media** field (**Single asset**) + +### Step 3. Create a `Post` model + +From the project setting page, create a new **Model**: + +- The name should be `Post`. +- **Important:** From the "Additional Settings" tab, turn on **Enable draft/published system.** This lets you preview the content. + +Next, add these fields (you don't have to modify the settings unless specified): + +- `Title` - **Text** field (**Single-line String**) +- `Content` - **Text** field (**Multiple-paragraph Text**) +- `Excerpt` - **Text** field (**Single-line String**) +- `Cover Image` - **Media** field (**Single asset**) +- `Date` - **Date and time** field (**Date**) +- `Author` - **Links** field (**Single link**) , and from the "Validations" tab under "Accept only specified model", select **Author**. +- `Slug` - **SEO** field (**Slug**), and from the "Validations" tab under "Reference field" select **Title**. + +### Step 4. Populate Content + +From the **Content** menu at the top, 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 5. Set up environment variables + +Go to the **Settings** menu at the top and click **API tokens**. + +Then click **Read-only API token** and copy the token. + +Next, 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_DATOCMS_API_TOKEN` should be the API token you just copied. +- `NEXT_EXAMPLE_CMS_DATOCMS_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). + +Your `.env` file should look like this: + +```bash +NEXT_EXAMPLE_CMS_DATOCMS_API_TOKEN=... +NEXT_EXAMPLE_CMS_DATOCMS_PREVIEW_SECRET=... +``` + +### Step 6. 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 7. Try preview mode + +On DatoCMS, go to one of the posts you've created and: + +- **Update the title**. For example, you can add `[Draft]` in front of the title. +- Click **Save**, but **DO NOT** click **Publish**. By doing this, the post will be in the draft state. + +(If it doesn't become draft, you need to go to the model settings for `Post`, go to **Additional Settings**, and turn on **Enable draft/published system**.) + +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 enable the Preview Mode, go to this URL: + +``` +http://localhost:3000/api/preview?secret=&slug= +``` + +- `` should be the string you entered for `NEXT_EXAMPLE_CMS_DATOCMS_PREVIEW_SECRET`. +- `` should be the post's `slug` attribute (you can check on DatoCMS). + +You should now be able to see the updated title. To exit the preview mode, you can click **Click here to exit preview mode** at the top. + +### Step 8. 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 `` and `` with the corresponding strings in `.env`. + +``` +now secrets add next_example_cms_datocms_api_token +now secrets add next_example_cms_datocms_preview_secret +``` + +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-datocms/components/alert.js b/examples/cms-datocms/components/alert.js new file mode 100644 index 000000000000..3530e66e59c8 --- /dev/null +++ b/examples/cms-datocms/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 is 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-datocms/components/avatar.js b/examples/cms-datocms/components/avatar.js new file mode 100644 index 000000000000..b0f258890830 --- /dev/null +++ b/examples/cms-datocms/components/avatar.js @@ -0,0 +1,12 @@ +export default function Avatar({ name, picture }) { + return ( +
+ {name} +
{name}
+
+ ) +} diff --git a/examples/cms-datocms/components/container.js b/examples/cms-datocms/components/container.js new file mode 100644 index 000000000000..fc1c29dfb074 --- /dev/null +++ b/examples/cms-datocms/components/container.js @@ -0,0 +1,3 @@ +export default function Container({ children }) { + return
{children}
+} diff --git a/examples/cms-datocms/components/cover-image.js b/examples/cms-datocms/components/cover-image.js new file mode 100644 index 000000000000..d9f54beb0ab7 --- /dev/null +++ b/examples/cms-datocms/components/cover-image.js @@ -0,0 +1,28 @@ +import { Image } from 'react-datocms' +import cn from 'classnames' +import Link from 'next/link' + +export default function CoverImage({ title, responsiveImage, slug }) { + const image = ( + + ) + return ( +
+ {slug ? ( + + {image} + + ) : ( + image + )} +
+ ) +} diff --git a/examples/cms-datocms/components/date.js b/examples/cms-datocms/components/date.js new file mode 100644 index 000000000000..eac5681378bf --- /dev/null +++ b/examples/cms-datocms/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-datocms/components/footer.js b/examples/cms-datocms/components/footer.js new file mode 100644 index 000000000000..dbde8ff306ef --- /dev/null +++ b/examples/cms-datocms/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-datocms/components/header.js b/examples/cms-datocms/components/header.js new file mode 100644 index 000000000000..562e7e3eebb6 --- /dev/null +++ b/examples/cms-datocms/components/header.js @@ -0,0 +1,12 @@ +import Link from 'next/link' + +export default function Header() { + return ( +

+ + Blog + + . +

+ ) +} diff --git a/examples/cms-datocms/components/hero-post.js b/examples/cms-datocms/components/hero-post.js new file mode 100644 index 000000000000..2e432f495c98 --- /dev/null +++ b/examples/cms-datocms/components/hero-post.js @@ -0,0 +1,41 @@ +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-datocms/components/intro.js b/examples/cms-datocms/components/intro.js new file mode 100644 index 000000000000..5931b3c5961b --- /dev/null +++ b/examples/cms-datocms/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-datocms/components/layout.js b/examples/cms-datocms/components/layout.js new file mode 100644 index 000000000000..99d95353131e --- /dev/null +++ b/examples/cms-datocms/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}
+
+