Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Kick off your Gatsby + ButterCMS with this default boilerplate.

Live demo

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the default starter.

    # create a new Gatsby site using the default starter
    npx gatsby new my-default-starter

    If you run into an error with npx, you may need to first remove node_modules then run:

    yarn upgrade --latest
    yarn install
    gatsby develop
  2. Create Content

    For this template to work, you have to create your content on ButterCMS as stated here

  3. Configuration You need to add the API token from your dashboard, along with associated page types, content fileds, and pages.


        resolve: `gatsby-source-buttercms`,
        options: {
              authToken: `<API_TOKEN>`,
              // Optional array of Collection key 
              contentFields: {
                keys: [`collection_key`],
                // Optional. Set to 1 to enable test mode for viewing draft content.
                test: 0,
              // Optional array of page type keys
              pageTypes: [`page_type_key`],
              // Optional array of locales (if configured in your account)
              locales: [`en`, `es`, `fr`],
              preview: 1 // Return draft content
  4. Start developing.

    Navigate into your new site’s directory and start it up.

    cd my-default-starter/
    gatsby develop
  5. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the my-default-starter directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

├── node_modules
├── src
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── package-lock.json
├── package.json
  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  3. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  4. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  5. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  6. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  7. LICENSE: Gatsby is licensed under the MIT license.

  8. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  9. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  10. A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

Gatsby Cloud

While creating a site on Gatsby Cloud create BUTTER_CMS_TOKEN environment variable set to your Read API Token which could be found on the settings page


  1. In Gatsby Cloud go to Site Settings -> Webhook and copy Preview Webhook URL (
  2. In ButterCMS go to Webhooks page and paste copied value into Target URL input field and select appropriate Event i.e. post.all - blog post has any activity and click "Save"
  3. In Gatsby Cloud go to CMS Preview and copy preview site URL (
  4. In ButterCMS go to Preview Settings page and paste into Blog Posts input field url for blog posts. For this repository it is [copied preview site url]/blog/<slug> i.e.;slug> and click Save (
  5. To preview a post in ButterCMS (webhook should be set to post related event) go to the Posts dashboard ( and click on any post. Click Preview button and the preview panel will appear at the bottom of the page ( Make changes to the post and to preview how it would look like click Save Draft. The preview panel should update automatically and reflect made changes. Note, that it might take several seconds for preview site to update. To preview pages use the same approach.


Deploy to Netlify


View our Gatsby Blog engine and Gatsby Full CMS for other examples of using ButterCMS with Gatsby.


A starter template for spinning up a Gatsby+ ButterCMS site







No releases published


No packages published