Blocky

Build Status Code Climate

Blocky is a mountable Rails::Engine for managing editable content blocks throughout your application.

Installation

Add this line to your application's Gemfile:

gem "blocky"

Install the Blocky gem with Bundler:

$ bundle install

Use the install generator to set up Blocky:

$ rails g blocky:install

Configuration

The install generator will create config/initializers/blocky.rb:

Blocky.user_class           = "User"
Blocky.s3_access_key_id     = ENV["BLOCKY_S3_KEY"]
Blocky.s3_secret_access_key = ENV["BLOCKY_S3_SECRET"]
Blocky.s3_bucket            = ENV["BLOCKY_S3_BUCKET"]

Authentication

Blocky does not include authentication because there's a good chance you've already added authentication to your Rails app.

TODO: Add info about requirements/configuration.

Authorization

Blocky uses CanCan for authorization. By default, any logged in user can create, update, and delete any content block.

TODO: Add example for limiting access to admin users.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request