> ## Documentation Index
> Fetch the complete documentation index at: https://buttercms.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Rails starter project

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

<Info>
  **One-Click Deploy**: Skip local setup and [deploy to Vercel instantly](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FButterCMS%2Frails-starter-buttercms\&env=BUTTER_CMS_API_KEY\&envDescription=Your%20ButterCMS%20API%20Token\&envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F).
</Info>

## 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 the repo and install dependencies.

```bash theme={null}
$ 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.

```bash theme={null}
$ 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:

```bash theme={null}
$ bundle exec rails s
```

**Local Development**: [http://localhost:3000](http://localhost:3000)

**GitHub Repository**: [https://github.com/ButterCMS/rails-starter-buttercms](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

<CardGroup cols={1}>
  <Card title="Deploy to Heroku" icon="cloud" href="https://heroku.com/deploy?template=https://github.com/ButterCMS/rails-starter-buttercms">
    Deploy to Heroku with environment configuration
  </Card>
</CardGroup>

## Resources

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/ButterCMS/rails-starter-buttercms">
    View source code and contribute
  </Card>

  <Card title="Rails Guide" icon="book" href="../../frameworks/non-javascript-frameworks/rails">
    Framework integration guide
  </Card>
</CardGroup>

## Additional reading

* [JSON Serialization in Rails: A Complete Guide](https://buttercms.com/blog/json-serialization-in-rails-a-complete-guide/)
* [Launching Your Own Ruby Gem - Part 1: Build It](https://buttercms.com/blog/launching-your-own-ruby-gem-build-it/)
* [Discover the Best Ruby Frameworks for 2021 (4 Great Options!)](https://buttercms.com/blog/the-best-ruby-frameworks/)

## Next steps

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="../../core-concepts/content-types/pages">
    Learn about Pages, Collections, and Components
  </Card>

  <Card title="API Reference" icon="code" href="../../api">
    Explore the full ButterCMS API
  </Card>
</CardGroup>