Skip to main content
One-Click Deploy: Skip local setup and deploy to Vercel instantly.

Quick Start

1. Clone and install

git clone https://github.com/ButterCMS/gatsbyjs-starter-buttercms.git
cd gatsbyjs-starter-buttercms
npm install

2. Configure environment

Add your ButterCMS API token:
echo 'GATSBY_BUTTER_CMS_API_KEY=<Your API Token>' >> .env
Get your API token from Settings → API Tokens in the ButterCMS dashboard.

3. Start development server

npm run dev
Open http://localhost:8000/ to view your app.

What’s included

FeatureDescription
Pages & Page TypesPre-built page templates with drag-and-drop schema definition
ComponentsModular content blocks for dynamic landing pages
CollectionsStructured data for navigation, testimonials, FAQs
Blog EngineFull blog with posts, categories, tags, and search
Media CDNAutomatic image optimization via Filestack

Deploy options

Deploy to Vercel

One-click deploy with automatic builds on content changes

Deploy to Heroku

Deploy to Heroku with environment configuration

Resources

GitHub Repository

View source code and contribute

Gatsby Guide

Framework integration guide

Additional reading

Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API