Rails Starter

A Ruby on Rails ButterCMS Starter in Only Two Minutes

Get started using Ruby on Rails with this fully-functional Rails starter project, completely integrated with ButterCMS, a leading headless CMS that makes collaborative content management of your app as easy as pie.

In less than two minutes, you can clone from GitHub, plug in your token, and run locally. Or, if you prefer, you can instantly deploy to Heroku with a single click, giving you an app you can share with your team.

A screenshot of the ButterCMS starter project — View Project on Github

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 the 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

Ruby on Rails Quick Start Guide

This starter project will have you up and running with a rich Rails project in minutes. It comes integrated with ButterCMS, a feature-filled SaaS CMS.

Native support for user-created Pages, including reusable Page Types. Define your Page schema once by dragging and dropping desired fields with the easy-to-use graphical interface inside the Butter dashboard. Team members can then roll out as many pages of that type as needed.
Global components and Collection Items, which allow you to define content and partial schemas that can then be reused on any page.
Powerful, native media-file handling and CDN via Filestack. Make static file management a thing of the past.

How to start the Rails project

Our Rails + ButterCMS starter project is designed to showcase all the features of ButterCMS, including the usage of Components for content modeling and Collections to build the customizable navigation. Once you've set up your starter project, you'll be able to log into your new Butter account and make changes to your content in real-time! Follow the steps above to get running locally.