Ruby starter project

Get up and running with Ruby and ButterCMS in under two minutes, with a starter that showcases Pages, Collections, and a Blog engine.

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

Feature	Description
Pages & Page Types	Pre-built page templates with drag-and-drop schema definition
Components	Modular content blocks for dynamic landing pages
Collections	Structured data for navigation, testimonials, FAQs
Blog Engine	Full blog with posts, categories, tags, and search
Media CDN	Automatic 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

• Launching Your Own Ruby Gem - Part 1: Build It
• Launching Your Own Ruby Gem (Part 2): Popularizing it Within the Ruby Community
• Discover the Best Ruby Frameworks for 2021 (4 Great Options!)

Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API