An extendable Ruby on Rails 'CMS framework' that supports Rails 3
Ruby HTML CSS JavaScript CoffeeScript
Pull request Compare This branch is 121 commits behind refinery:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
config
core
doc/guides
exe
images
lib
pages
resources
spec
tasks
templates/refinery
testing
tmp/pids
.gitignore
.pullreview.yml
.rspec
.travis.yml
.yardopts
Gemfile
Rakefile
changelog.md
config.ru
contributing.md
license.md
readme.md
refinerycms.gemspec

readme.md

Refinery CMS

An open source content management system for Rails 4.2+

More information at http://refinerycms.com

Build Status Code Climate Coverage Status

You can chat with us using Gitter:

Gitter chat

Requirements

How to

Getting Started

If you're new to Refinery, start with this guide:

If you want to use Rails 4.2.x with Refinery now, install using this template:

rails new app_name -m http://refinerycms.com/t/edge

What's it good at?

Refinery is great for sites where the client needs to be able to update their website themselves without being bombarded with anything too complicated.

Unlike other content managers, Refinery is truly aimed at the end user making it easy for them to pick up and make changes themselves.

For developers

  • Easily customise the look to suit the business.
  • Extend with custom extensions to do anything Refinery doesn't do out of the box.
  • Sticks to "the Rails way" as much as possible; we don't force you to learn new templating languages.
  • Uses jQuery for fast and concise Javascript.

Demo

Wanna see Refinery for yourself? Try the demo.

Help and Documentation

Features

Pages

  • Easily edit and manage pages with a visual editor.
  • Manage your site's structure.

Images & Files

  • Easily upload and insert images.
  • Upload and link to resources such as PDF documents.
  • Uses the popular Dragonfly.
  • Supports storage on Amazon S3.

Authentication & Users

  • Manage who can access Refinery.
  • Control which extensions each user has access to.
  • Uses the popular Devise.

Custom Extensions

Extend Refinery easily by running the Refinery extension generator. For help run the command without any options:

rails generate refinery:engine

Popular Extensions

  • Blog - A simple blogging extension that supports posts, categories and comments with optional moderation support.
  • Portfolio - manage groups of images like an image gallery.
  • News - post and manage news items.
  • Inquiries - simple contact form that notifies you and customer when an inquiry is made.

Full extension list here

Example Site Showcase

List here (add your link when you're done)

Contributing

See contributing.md and Contributing to Refinery guide for details about contributing and running test.

License

Refinery is released under the MIT license. See the license.md file for details.

Credits

Many of the icons used in Refinery CMS are from the wonderful Silk library by Mark James.