Skip to content
Cloudflare Docs

Gatsby

Gatsby ↗ 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:

Terminal window
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 ↗:

Terminal window
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:

Terminal window
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. Log in to the Cloudflare dashboard ↗ and select your account.
  2. In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
  3. Select the new GitHub repository that you created and, in the Set up builds and deployments section, 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.

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.

Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings