Welcome to TrustyCMS
TrustyCMS is a branch of Radiant CMS. Its goal is to pull the Radiant framework into Rails 6 with minimal changes to its infrastructure.
TrustyCMS is a no-fluff, open source content management system designed for small teams. It is similar to Textpattern or MovableType, but is a general purpose content management system (not just a blogging engine). TrustyCMS is a Rails engine and is built to be installed into an existing Rails 5 application as a gem.
TrustyCMS features:
- An elegant user interface
- The ability to arrange pages in a hierarchy with drag and drop
- Flexible templating with layouts, snippets, page parts, and a custom tagging language
- A simple user management/permissions system
- Support for Markdown and Textile as well as traditional HTML (it's easy to create other filters)
- An advanced plugin system
- Asset management
- Serve multiple sites (domains) from a single instance
- Social sharing buttons
- Reusable bits of content (Snippets)
- Allows Rails controllers/actions to use Trusty CMS layouts as their "layout"
- Operates in two modes: dev and production depending on the URL
- A caching system which expires pages every 5 minutes
- Built using Ruby on Rails (version 5)
License
TrustyCMS is released under the MIT license. The Radiant portions of the codebase are copyright (c) John W. Long and Sean Cribbs; anything after the fork is copyright (c) Pittsburgh Cultural Trust. A copy of the MIT license can be found in the LICENSE file.
Installation and Setup for Use
TrustyCMS is a traditional Ruby on Rails engine, meaning that you can configure and run it the way you would a normal gem, like Devise.
See the INSTALL.md file for more instructions.
Installation and Setup for Contributing to TrustyCMS
Setup
Prerequisites:
- A Github account and Git (Github has some really good instructions)
- Ruby 2.2.0 or higher
- A Rails application (currently supports version 5.0)
- Bundler
- MySQL
- PhantomJS >= 1.8.1
Steps:
-
Fork this repository to your Github account.
-
Clone your fork to your machine.
-
cd
into the directory you just cloned into. -
Follow the INSTALL.md instructions to setup an empty app with TrustyCMS installed. To modify TrustyCMS, point your dependency to the local path of your fork.
gem 'trusty-cms', path: '../trusty-cms'
-
Set up your databases in your Rails application:
bundle exec rake db:create bundle exec rake db:migrate
-
Run the tests to make sure they pass (If they don't, file a bug!):
rspec
When you're ready to make a change:
- Add the pgharts fork as a git remote called "upstream":
git remote add upstream https://github.com/pgharts/trusty-cms.git
so that you can keep up with changes that other people make. - Fetch the remote you just added:
git fetch upstream
. - Start a new branch for the change you're going to make. Name it something having to do with the changes, like "fix-queries" if you are going to try to fix some queries. Base this branch on
upstream/master
by runninggit checkout -b fix-queries upstream/master
. - Make your changes and commit them. Please include tests!
- Run the tests and make sure they pass.
- Push your changes to your github fork:
git push origin fix-queries
. - Send a pull request to the pgharts fork.
Support
All of the development for TrustyCMS happens on Github:
https://github.com/pgharts/trusty-cms
TrustyCMS is supported in part by:
Enjoy!
-- The TrustyCMS Dev Team