Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A hump yard for your pages in Rails 3
JavaScript Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
compass
config
db/migrate
features
lib
spec
test
.gitignore
Gemfile
LICENSE
README.rdoc
Rakefile
VERSION
humpyard.gemspec

README.rdoc

humpyard

Humpyard is a CMS in a gem for Rails 3.

Installation

  • Add Humpyard to your Rails application's Gemfile. It does require edge rails at the moment.

    gem "rails",         '>=3.0.0'
    gem 'builder'
    gem 'haml',          '>=3.0.0'
    gem 'compass',       '>=0.10.0'
    gem 'acts_as_tree',  '>=0.1.1'
    gem 'cancan',        '>=1.3.4'
    gem 'globalize3',    '>=0.0.7'
    gem 'humpyard_form', '>=0.0.4'
    gem 'humpyard',      :git => 'git://github.com/humpyard/humpyard.git'
  • If you want to use textil syntax on TextElements also add RedCloth to the Gemfile.

    gem 'RedCloth',      '>=4.2.3'
  • Change into your Rails application's directory

  • Generate Humpyard skeleton

    rails generate humpyard:skeleton

    A full documentation of options for creating a humpyard skeleton can be found at the Humpyard::Generators::ElementGenerator section of this documentation.

  • Use an Auth Framework

    rails generate humpyard:auth

    At the moment there is only a fake user framework for toggling if the admin-user is logged in or not. There are going to be generators for both, Authlogic and Devise, as soon as we get those to work with edge Rails.

    As the abilities in Humpyard are defined by CanCan, it should be possible to use any auth framework to authentice your users.

  • Migrate the Humpyard database tables

    rake humpyard:db:migrate
  • Create an initial root page (recommended)

    rake humpyard:pages:create_root

API Documentation

  • API Documentation can be created by running

    rake rdoc

    from the humpyard project directory.

  • There is an auto-generated, up-to-the-hour online_documentation of the API Documentation.

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. No discussion. No tests, no game. We use rspec and cucumber with associated addons.

  • Commit, do not mess with rakefile, version, or history. If you want to have your own version, thats fine. But bump your version in a seperate commit that can be ignored when pulling.

  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright © 2010 Sven G. Brönstrup. See LICENSE for details.

Something went wrong with that request. Please try again.