Welcome to TrustyCMS

Gem Version

Trusty is a branch of the venerable Radiant CMS. Its goal is to pull the Radiant framework into Rails 4 with minimal changes to its infrastructure. Most of what is below is derived from the original Radiant CMS readme.

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).

Build Status

Currently, TrustyCMS is functional but still has some core issues. We're managing the outstanding problems in Github Issues, so if you'd like to help out, that's a great place to start. Also, if you find anything wrong, let us know there so we can get to work fixing it.

TrustyCms features:

  • An elegant user interface
  • The ability to arrange pages in a hierarchy
  • Flexible templating with layouts, snippets, page parts, and a custom tagging language (Radius: http://radius.rubyforge.org)
  • 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
  • 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
  • And much more...

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 application, meaning that you can configure and run it the way you would a normal Rails application.

See the INSTALL file for more details.

Installation and Setup for Contributing to TrustyCms

Part A of setup, common to both kinds of installations

Prerequisites:

Steps:

  1. Fork this repository to your github account.
  2. Clone your fork to your machine.
  3. cd into the directory you just cloned into.

Part B, the Vagrant install way

To get a development environment up and running quickly, we have a vagrant box with the dependencies you'll need! Just follow these steps:

  1. Download and install Vagrant
  2. Download and install Virtualbox
  3. Download this box into the directory with your code and make sure the file is named "trusty-cms.box".
  4. Run vagrant up to start the virutal environment
  5. Run vagrant ssh to ssh into the virtual environment
  6. cd /vagrant to get to the directory with the rails code that's shared with your computer.

You can edit the files in this directory with your favorite editor on your machine. The files are shared into the /vagrant directory in the virtual machine.

When you're done using the vagrant environment, you can run vagrant destroy to stop the vm and remove all guest hard disks. Next time you want to use it, just start from the vagrant up step again!

Part B, the native install way to set up

Prerequisites:

  1. Install the gems with bundler: bundle

Part C of setup, common to both kinds of installations

  1. Create a database configuration: cp config/database.mysql.yml config/database.yml. You probably don't need to make any further changes.

  2. Set up your databases:

    bundle exec rake db:create
bundle exec rake db:migrate
bundle exec rake db:migrate:extensions
bundle exec rake db:test:prepare

  3. Run the tests to make sure they pass (If they don't, file a bug!):

    rspec

  4. Run rails s to start the server. Visit the site in your browser at http://localhost:3000.

When you're ready to make a change:

  1. 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.
  2. Fetch the remote you just added: git fetch upstream
  3. 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 running git checkout -b fix-queries upstream/master
  4. Make your changes and commit them. Please include tests!
  5. Run the tests and make sure they pass.
  6. Push your changes to your github fork: git push origin fix-queries
  7. Send a pull request to the pgharts fork
  8. High five the nearest person!

Support

The best place to get support is on the Pittsburgh Ruby mailing list:

https://groups.google.com/forum/#!forum/rubypgh

Most of the development for TrustyCms happens on Github:

https://github.com/pgharts/trusty-cms

TrustyCMS is supported in part by https://www.browserstack.com/

Enjoy!

-- The TrustyCms Dev Team