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

​
Quick start

Make sure you have ruby version 3.1.0 installed. Otherwise, follow the official instructions on how to set up ruby on your machine. Then, clone repo and install dependencies: 
$ git clone https://github.com/ButterCMS/rails-starter-buttercms.git
$ cd rails-starter-buttercms
$ bundle install
To fetch your ButterCMS content, add your API token as an environment variable. 
$ echo 'RAILS_BUTTER_CMS_API_KEY=<Your API Token>' >> .env
To view the app in the browser, you’ll need to run the local development server: 
$ bundle exec rails s
Local Development: http://localhost:3000 GitHub Repository: https://github.com/ButterCMS/rails-starter-buttercms

​
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 Heroku

Deploy to Heroku with environment configuration

​
Resources

GitHub Repository

View source code and contribute

Rails Guide

Framework integration guide

​
Additional reading

​
Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API