Gatsby Default Starter

Gatsby Default Starter is the official boilerplate for building React-based static sites with Gatsby, providing the minimal configuration files needed to start a new project.

What is Gatsby Default Starter?

Gatsby Default Starter is the official minimal starter template for Gatsby, a React-based open source framework for building static sites. It ships with the main Gatsby configuration files — gatsby-config.js, gatsby-node.js, gatsby-browser.js, and gatsby-ssr.js — plus a src directory for front-end code and standard project files like package.json and .gitignore. Running it produces a new Gatsby site with a homepage at src/pages/index.js that you can edit with live reload.

Key Features

• Configuration files — Includes gatsby-config.js for site metadata and plugins, gatsby-node.js for Node APIs, gatsby-browser.js for browser APIs, and gatsby-ssr.js for server-side rendering customization.
• GraphiQL explorer — During development, a second local endpoint at localhost:8000/___graphql lets you experiment with GraphQL queries against the Gatsby data layer.
• Gatsby Cloud one-click deploy — The starter links directly to Gatsby Cloud for building, deploying, and hosting on an edge network built for Gatsby.
• 0BSD license — The starter is released under the 0BSD license, so you can replace the LICENSE file with your own.
• Standard project structure — Includes node_modules, src, .gitignore, package.json, LICENSE, README.md, and the four Gatsby API config files, making the layout clear.
• React-based front-end — All user-facing code lives in /src and is written in React components, starting with the index page.

Who is it for?

• Developers new to Gatsby — Follow the quick start to create a site with the Gatsby CLI and explore the tutorial links included in the README.
• Web developers needing a baseline — Use the starter as a minimal foundation for building static sites, then add plugins and pages as needed.
• Teams deploying to Gatsby Cloud — The one-click deploy option targets teams that want build, deploy, and hosting on Gatsby's dedicated cloud platform.

What can you do with it?

• Landing page developers: Start a new landing page by editing src/pages/index.js and see browser updates in real time after saving.
• Portfolio builders: Use the default starter to scaffold a personal portfolio site and then add the Gatsby plugins and components you need.
• Content sites: Extend the starter with data sources and templates, using GraphiQL to explore and query the data layer before writing code.

How does the template work?

You create a site by running gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default. Navigate into the directory, run gatsby develop, and the site runs at http://localhost:8000. Edit src/pages/index.js and the browser refreshes automatically; open http://localhost:8000/___graphql to experiment with GraphQL queries.

FAQ

Is Gatsby Default Starter free?

Yes. The starter is released under the 0BSD license, and Gatsby itself is an open source framework. You can use the starter for any project without licensing fees.

What configuration files are included?

The starter includes gatsby-config.js, gatsby-node.js, gatsby-browser.js, and gatsby-ssr.js, plus package.json, .gitignore, LICENSE, README.md, and a src directory for your front-end code.

How do I start a new site with this starter?

Run gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default with the Gatsby CLI installed, then cd into the directory and run gatsby develop.

What is the GraphiQL tool?

GraphiQL is accessible at http://localhost:8000/___graphql while developing. It lets you explore the Gatsby data layer and write GraphQL queries against your site's content.

Can I deploy this starter?

Yes. The README includes a one-click deploy button for Gatsby Cloud, which builds, deploys, and hosts the site on Gatsby's edge network.