Ruby Logo

Ruby CMS

ButterCMS is an API-based CMS that integrates with Ruby apps in minutes. Use ButterCMS with Rails, Sinatra, and other Ruby frameworks to build CMS-powered apps quickly. ButterCMS works great for blogs, dynamic pages, and more.

Table of Contents

Introduction

Learn how to create dynamic pages using Butter.

Creating dynamic pages with Butter is a two-step process:

1) Setup custom content fields in Butter
2) Integrate the fields into your application

This guide uses the Sinatra web framework but Butter integrates with any Ruby web app (we also have a Rails guide). If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Setup content fields

Let's suppose we want to be able to create pages for retail-chain locations using ButterCMS and we're starting out with a basic static page template for a single location:

app.rb:

require 'rubygems'
require 'bundler'
require 'buttercms-ruby'

ButterCMS::api_token = ''

class App < Sinatra::Base
  get '/locations/chicago' do
    erb :location
  end
end

views/location.html.erb:

<h1>Widget Store - Chicago</h1>
<img width="100%" src="/images/chicago.jpg">
<p>Our Chicago location is located at 566 Wacker Drive.</p>

Enabling new pages to be created with Butter is a two-step process:

  1. Setup custom content fields in Butter
  2. Integrate the fields into your application

To setup custom content fields, first sign in to the Butter dashboard.

Create a new workspace or click on an existing one. Workspaces let you organize content fields in a friendly way for content editors and have no effect on development or the API. For example, a real-estate website might have a workspace called "Properties" and another called "About Page".

Once you're in a workspace click the button to create a new content field. Choose the "Collection" type and name the field "Location Pages":

On the next screen, we'll setup the properties for each page in the collection.

Now go back to the work space and create a location:

Integrating your app

To create these pages in our app, we create a dynamic route that fetches content for the page by using a URL parameter. Here's what the code looks like:

app.rb:

require 'rubygems'
require 'bundler'
require 'buttercms-ruby'

ButterCMS::api_token = ''

class App < Sinatra::Base
  get '/locations/:location_slug' do
    slug = params[:location_slug]

    # Filter list by slug
    result = ButterCMS::Content.fetch(["location_pages[slug=#{slug}]"]).data

    # location_pages is a collection so we call call `.first` on it
    @location = result.location_pages.first

    erb :location
  end
end

views/location.html.erb:

<h1>Widget Store - <%= @location.name %></h1>
<img width="100%" src="<%= @location.feature_image %>">
<p><%= @location.description %></p>

That's it! If you browse to /locations/chicago, you'll see the content we just entered into Butter.

If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

About Ruby

Ruby is a dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write.

Headless CMS for these technologies and more

Ruby, Rails, Node.js, Python, ASP.NET, Flask, Django, Go, PHP, Laravel, Angular, React, Elixir, Phoenix, Meteor, Vue.js, Javascript, Heroku

Get started now

Sign up with Google Sign up with Github
or