Migrating from Gatsby

This guide will help you understand how to transition from an existing Gatsby project to Next.js. Migrating to Next.js will allow you to:

And more! Let’s walk through a series of steps to complete the migration.

Updating package.json and dependencies

The first step towards migrating to Next.js is to update package.json and dependencies. You should:

  • Remove all Gatsby-related packages (but keep react and react-dom).
  • Install next.
  • Add Next.js related commands to scripts. One is next dev, which runs a development server at localhost:3000. You should also add next build and next start for creating and starting a production build.

Here’s an example package.json (view diff):

  1. {
  2.   "scripts": {
  3.     "dev": "next dev",
  4.     "build": "next build",
  5.     "start": "next start"
  6.   },
  7.   "dependencies": {
  8.     "next": "latest",
  9.     "react": "latest",
  10.     "react-dom": "latest"
  11.   }
  12. }

Static Assets and Compiled Output

Gatsby uses the public directory for the compiled output, whereas Next.js uses it for static assets. Here are the steps for migration (view diff):

  • Remove .cache/ and public from .gitignore and delete both directories.
  • Rename Gatsby’s static directory as public.
  • Add .next to .gitignore.

Creating Routes

Both Gatsby and Next support a pages directory, which uses file-system based routing. Gatsby’s directory is src/pages, which is also supported by Next.js.

Gatsby creates dynamic routes using the createPages API inside of gatsby-node.js. With Next, we can use Dynamic Routes inside of pages to achieve the same effect. Rather than having a template directory, you can use the React component inside your dynamic route file. For example:

  • Gatsby: createPages API inside gatsby-node.js for each blog post, then have a template file at src/templates/blog-post.js.
  • Next: Create pages/blog/[slug].js which contains the blog post template. The value of slug is accessible through a query parameter. For example, the route /blog/first-post would forward the query object { 'slug': 'first-post' } to pages/blog/[slug].js (learn more here).

Styling

With Gatsby, global CSS imports are included in gatsby-browser.js. With Next, you should create a custom _app.js for global CSS. When migrating, you can copy over your CSS imports directly and update the relative file path, if necessary. Next.js has built-in CSS support.

Links

The Gatsby Link and Next.js Link component have a slightly different API. First, you will need to update any import statements referencing Link from Gatsby to:

  1. import Link from 'next/link'

Next, you can find and replace usages of to="/route" with href="/route".

Data Fetching

The largest difference between Gatsby and Next.js is how data fetching is implemented. Gatsby is opinionated with GraphQL being the default strategy for retrieving data across your application. With Next.js, you get to choose which strategy you want (GraphQL is one supported option).

Gatsby uses the graphql tag to query data in the pages of your site. This may include local data, remote data, or information about your site configuration. Gatsby only allows the creation of static pages. With Next.js, you can choose on a per-page basis which data fetching strategy you want. For example, getServerSideProps allows you to do server-side rendering. If you wanted to generate a static page, you’d export getStaticProps / getStaticPaths inside the page, rather than using pageQuery. For example:

  1. // src/pages/[slug].js
  3. // Install remark and remark-html
  4. import remark from 'remark'
  5. import html from 'remark-html'
  6. import { getPostBySlug, getAllPosts } from '../lib/blog'
  8. export async function getStaticProps({ params }) {
  9.   const post = getPostBySlug(params.slug)
  10.   const content = await remark()
  11.     .use(html)
  12.     .process(post.content || '')
  13.     .toString()
  15.   return {
  16.     props: {
  17.       ...post,
  18.       content,
  19.     },
  20.   }
  21. }
  23. export async function getStaticPaths() {
  24.   const posts = getAllPosts()
  26.   return {
  27.     paths: posts.map((post) => {
  28.       return {
  29.         params: {
  30.           slug: post.slug,
  31.         },
  32.       }
  33.     }),
  34.     fallback: false,
  35.   }
  36. }

You’ll commonly see Gatsby plugins used for reading the file system (gatsby-source-filesystem), handling markdown files (gatsby-transformer-remark), and so on. For example, the popular starter blog example has 15 Gatsby specific packages. Next takes a different approach. It includes common features directly inside the framework, and gives the user full control over integrations with external packages. For example, rather than abstracting reading from the file system to a plugin, you can use the native Node.js fs package inside getStaticProps / getStaticPaths to read from the file system.

  1. // src/lib/blog.js
  3. // Install gray-matter and date-fns
  4. import matter from 'gray-matter'
  5. import { parseISO, format } from 'date-fns'
  6. import fs from 'fs'
  7. import { join } from 'path'
  9. // Add markdown files in `src/content/blog`
  10. const postsDirectory = join(process.cwd(), 'src', 'content', 'blog')
  12. export function getPostBySlug(slug) {
  13.   const realSlug = slug.replace(/\\.md$/, '')
  14.   const fullPath = join(postsDirectory, `${realSlug}.md`)
  15.   const fileContents = fs.readFileSync(fullPath, 'utf8')
  16.   const { data, content } = matter(fileContents)
  17.   const date = format(parseISO(data.date), 'MMMM dd, yyyy')
  19.   return { slug: realSlug, frontmatter: { ...data, date }, content }
  20. }
  22. export function getAllPosts() {
  23.   const slugs = fs.readdirSync(postsDirectory)
  24.   const posts = slugs.map((slug) => getPostBySlug(slug))
  26.   return posts
  27. }

Site Configuration

With Gatsby, your site’s metadata (name, description, etc) is located inside gatsby-config.js. This is then exposed through the GraphQL API and consumed through a pageQuery or a static query inside a component.

With Next.js, we recommend creating a config file similar to below. You can then import this file anywhere without having to use GraphQL to access your site’s metadata.

  1. // src/config.js
  3. export default {
  4.   title: 'Starter Blog',
  5.   author: {
  6.     name: 'Lee Robinson',
  7.     summary: 'who loves Next.js.',
  8.   },
  9.   description: 'A starter blog converting Gatsby -> Next.',
  10.   social: {
  11.     twitter: 'leeerob',
  12.   },
  13. }

Search Engine Optimization

Most Gatsby examples use react-helmet to assist with adding meta tags for proper SEO. With Next.js, we use next/head to add meta tags to your <head /> element. For example, here’s an SEO component with Gatsby:

  1. // src/components/seo.js
  3. import { Helmet } from 'react-helmet'
  5. export default function SEO({ description, title, siteTitle }) {
  6.   return (
  7.     <Helmet
  8.       title={title}
  9.       titleTemplate={siteTitle ? `%s | ${siteTitle}` : null}
  10.       meta={[
  11.         {
  12.           name: `description`,
  13.           content: description,
  14.         },
  15.         {
  16.           property: `og:title`,
  17.           content: title,
  18.         },
  19.         {
  20.           property: `og:description`,
  21.           content: description,
  22.         },
  23.         {
  24.           property: `og:type`,
  25.           content: `website`,
  26.         },
  27.         {
  28.           name: `twitter:card`,
  29.           content: `summary`,
  30.         },
  31.         {
  32.           name: `twitter:creator`,
  33.           content: twitter,
  34.         },
  35.         {
  36.           name: `twitter:title`,
  37.           content: title,
  38.         },
  39.         {
  40.           name: `twitter:description`,
  41.           content: description,
  42.         },
  43.       ]}
  44.     />
  45.   )
  46. }

And here’s the same example using Next.js, including reading from a site config file.

  1. // src/components/seo.js
  3. import Head from 'next/head'
  4. import config from '../config'
  6. export default function SEO({ description, title }) {
  7.   const siteTitle = config.title
  9.   return (
  10.     <Head>
  11.       <title>{`${title} | ${siteTitle}`}</title>
  12.       <meta name="description" content={description} />
  13.       <meta property="og:type" content="website" />
  14.       <meta property="og:title" content={title} />
  15.       <meta property="og:description" content={description} />
  16.       <meta property="og:site_name" content={siteTitle} />
  17.       <meta property="twitter:card" content="summary" />
  18.       <meta property="twitter:creator" content={config.social.twitter} />
  19.       <meta property="twitter:title" content={title} />
  20.       <meta property="twitter:description" content={description} />
  21.     </Head>
  22.   )
  23. }

Learn more

Take a look at this pull request for more details on how an app can be migrated from Gatsby to Next.js. If you have questions or if this guide didn’t work for you, feel free to reach out to our community on GitHub Discussions.