Rails CMS

ButterCMS is an API-based CMS that integrates with Ruby on Rails apps in minutes. ButterCMS is great for blogs, dynamic pages, and more.

Table of Contents

• Introduction
• Setup content fields
• Integrate your app

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:

config/routes.rb:

get '/locations/:slug' => 'locations#show'

controllers/locations_controller.rb:

class LocationsController < ApplicationController
  def show
  end
end

views/locations/show.html.erb:

<h1>Widget Store - Chicago</h1>
<img 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:

controllers/locations_controller.rb:

class LocationsController < ApplicationController
  def show
    slug = params[: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
  end
end

views/locations/show.html.erb:

<h1>Widget Store - <%= @location.name %></h1>
<img 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.

Check out our open-source code for an example blog built with Sinatra and ButterCMS.