https://github.com/refinery/refinerycms
An extendable Ruby on Rails CMS that supports Rails 6.0+
https://github.com/refinery/refinerycms
demo hacktoberfest inquiry news rails refinery refinery-cms ruby
Last synced: 2 days ago
JSON representation
An extendable Ruby on Rails CMS that supports Rails 6.0+
- Host: GitHub
- URL: https://github.com/refinery/refinerycms
- Owner: refinery
- License: mit
- Created: 2009-05-28T20:13:21.000Z (almost 17 years ago)
- Default Branch: main
- Last Pushed: 2023-08-06T07:08:40.000Z (almost 3 years ago)
- Last Synced: 2025-04-23T17:17:41.940Z (about 1 year ago)
- Topics: demo, hacktoberfest, inquiry, news, rails, refinery, refinery-cms, ruby
- Language: Ruby
- Homepage: https://www.refinerycms.com/
- Size: 26.2 MB
- Stars: 3,907
- Watchers: 115
- Forks: 1,250
- Open Issues: 45
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: license.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ruby-toolbox - Refinery CMS - A Ruby on Rails CMS that supports Rails 4.2. It's developer friendly and easy to extend. (Content Management & Blogging / Content Management)
- Open-Source-Ruby-and-Rails-Apps - RefineryCMS - An extendable Ruby on Rails CMS that supports Rails 6.0+ 🔥 ✅ (Happy Exploring 🤘)
- awesome-homelab - Refinery CMS
README
# Refinery CMS
__An open source content management system for Rails 6.1+ through 8.1+__
You can deploy an example app to Heroku:
[](https://heroku.com/deploy?template=https://github.com/refinery/refinerycms-example-app)
Note that some of our docs in this README are out of date, and our website is not currently live. Please refer to our [GitHub repository](https://github.com/refinery/refinerycms) for the current status and instructions. Guides can be found in the [doc/guides](https://github.com/refinery/refinerycms/tree/main/doc/guides) folder.
## Requirements
* [Bundler](https://bundler.io/)
* [ImageMagick](https://imagemagick.org/script/install-source.php)
* :warning: Warning: ImageMagick currently has a serious security vulnerability, CVE-2016–3714. After installing, you must disable certain features in ImageMagick's policy configuration. Please see the following for details:
* https://imagetragick.com/
* Mac OS X users should use [homebrew's](https://github.com/mxcl/homebrew/wiki/installation) `brew install imagemagick` or the [magick-installer](https://github.com/maddox/magick-installer).
## How to
* __[Install Refinery CMS](https://www.refinerycms.com/download)__
* [Install Refinery CMS on Heroku](https://github.com/refinery/refinerycms/blob/main/doc/guides/7%20-%20Hosting%20and%20Deployment/1%20-%20Heroku.md)
* [Contribute to Refinery CMS](readme.md#contributing)
## Getting Started
If you're new to Refinery, start with this guide:
* __[Getting Started](https://github.com/refinery/refinerycms/tree/main/doc/guides/1%20-%20Getting%20Started)__
For Rails 5.1+ support, you can use version `4.0.x` using this template:
rails new app_name -m https://www.refinerycms.com/t/4.0.0
For Rails 4.2.x support, you can use version `3.0.x` using this template:
rails new app_name -m https://www.refinerycms.com/t/3.0.6
You can also install the `edge` version for the latest code using this template:
rails new app_name -m https://www.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](http://jquery.com/) for now, for fast and concise Javascript.
## Help and Documentation
* [Getting Started](https://github.com/refinery/refinerycms/tree/main/doc/guides/1%20-%20Getting%20Started)
* [Google Group Discussion](https://groups.google.com/g/refinery-cms)
* [GitHub repository](https://github.com/refinery/refinerycms)
* [Developer/API documentation](http://rubydoc.info/github/refinery/refinerycms)
* [Twitter Account](https://twitter.com/refinerycms)
## 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](https://github.com/markevans/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](https://github.com/plataformatec/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](https://github.com/refinery/refinerycms-blog) - A simple blogging extension that supports posts, categories and comments with optional moderation support.
* [Portfolio](https://github.com/refinery/refinerycms-portfolio) - manage groups of images like an image gallery.
* [News](https://github.com/refinery/refinerycms-news) - post and manage news items.
* [Inquiries](https://github.com/refinery/refinerycms-inquiries) - simple contact form that notifies you and customer when an inquiry is made.
[Full extension list here](https://www.refinerycms.com/extensions)
### Example Site Showcase
[List here (add your link when you're done)](https://github.com/refinery/refinerycms/wiki/Example-Site-Showcase)
## Contributing
See [contributing.md](contributing.md)
and [Contributing to Refinery](https://github.com/refinery/refinerycms/blob/main/doc/guides/8%20-%20Contributing/1%20-%20Contributing%20to%20Refinery.md)
guide for details about contributing and running test.
## License
Refinery CMS is released under the MIT license. See the [license.md file](license.md#readme) for details.
### Credits
Many of the icons used in Refinery CMS are from the wonderful [Silk library by Mark James](http://www.famfamfam.com/lab/icons/silk/).