Gatsby

Last updated Apr 21, 2026 is an open-source React framework for creating websites and apps. In this guide, you will create a new Gatsby application and deploy it using Cloudflare Pages. You will be using the gatsby CLI to create a new Gatsby site.

Install Gatsby

Install the gatsby CLI by running the following command in your terminal:

npm install -g gatsby-cli

Create a new project

With Gatsby installed, you can create a new project using gatsby new. The new command accepts a GitHub URL for using an existing template. As an example, use the gatsby-starter-lumen template by running the following command in your terminal. You can find more in Gatsby's Starters section ↗︎:

npx gatsby new my-gatsby-site https://github.com/alxshelepenok/gatsby-starter-lumen

Before you continue

All of the framework guides assume you already have a fundamental understanding of Git ↗︎. If you are new to Git, refer to this summarized Git handbook ↗︎ on how to set up Git on your local machine.

If you clone with SSH, you must generate SSH keys ↗︎ on each computer you use to push or pull from GitHub.

Refer to the GitHub documentation ↗︎ and Git documentation ↗︎ for more information.

Create a GitHub repository

Create a new GitHub repository by visiting repo.new ↗︎. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:

git remote add origin https://github.com/<your-gh-username>/<repository-name>
git branch -M main
git push -u origin main

Deploy with Cloudflare Pages

To deploy your site to Pages:

  1. In the Cloudflare dashboard, go to the Workers & Pages page. Go to Workers & Pages ↗
  2. Select Create application.
  3. Select the Pages tab.
  4. Select Import an existing Git repository.
  5. Select the new GitHub repository that you created and then select Begin setup.
  6. In the Build settings section, select Gatsby as your Framework preset. Your selection will provide the following information:

Configuration option | Value | Production branch | main | | --- | --- | | Build command | npx gatsby build | | Build directory | public |

After configuring your site, you can begin your first deploy. You should see Cloudflare Pages installing gatsby, your project dependencies, and building your site, before deploying it.

Note

For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.

After deploying your site, you will receive a unique subdomain for your project on *.pages.dev. Every time you commit new code to your Gatsby site, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to preview deployments on new pull requests, so you can preview how changes look to your site before deploying them to production.

Dynamic routes

If you are using dynamic routes ↗︎ in your Gatsby project, set up a proxy redirect for these routes to take effect.

If you have a dynamic route, such as /users/[id], create your proxy redirect by referring to the following example:

/users/* /users/:id 200

Learn more

By completing this guide, you have successfully deployed your Gatsby site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.

Was this helpful?

YesNo

On this page

Gatsby - 图1Docs

{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gatsby-site/#page","headline":"Gatsby","description":"Deploy a Gatsby site to Cloudflare Pages.","url":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gatsby-site/","inLanguage":"en","image":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gatsby-site/og.png?v=08911cfd6eb9a18c","dateModified":"2026-04-21","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}

description: Deploy a Gridsome site to Cloudflare Pages. title: Gridsome image: https://developers.cloudflare.com/pages/framework-guides/deploy-a-gridsome-site/og.png?v=e8f10b91181aecc1

Skip to content

Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/pages/llms.txt
Use this file to discover all available pages before exploring further.