Formerly known as: Kuhsaft

qBrick is currently undergoing rapid changes as we are ramping up for our first official release under the new name. Until 2.5 is out, expect things to break.

qBrick started as a side project of the Screen Concept team as we got tired of fiddling with unusable content management systems. By following common rails practices and not being to opinionated, qBirck aims to be a plug and play CMS Engine that does not stand in your way or dictates how you have to build your Rails application, while still providing some sensible defaults and the basic functionality you would expect form a CMS system.

• A Rails 4 application
• ImageMagick
• An ActiveRecord compatible DB

Add it to your Gemfile:

gem 'qbrick', '2.5.0.pre'

Run the following command to install it:

bundle install

Then install the assets and the migrations and run them:

rake qbrick:install:migrations
rake db:migrate
rake db:seed
rails generate qbrick:assets:install

Load the Qbrick assets into your app, so you have working grids, widgets etc:

# application.css.sass
@import 'qbrick/application'

# application.js.coffee
//= require 'qbrick/application'

Also, you need to define the image sizes for the image brick or use the defaults:

# your_app/config/initializers/qbrick.rb
Rails.application.config.to_prepare do
  Qbrick::Engine.configure do
    config.image_sizes.build_defaults! # creates 960x540 and 320x180 sizes
  end
end

If you would like to use the qBrick helpers in your app, include them in your application controller:

class ApplicationController < ActionController::Base
  helper Qbrick::Engine.helpers
end

Finally, mount the qBrick engine in your routes file:

mount Qbrick::Engine => '/'

You can now access the qBrick interface by visiting /cms in your browser. By default, qBrick creates the first admin user with the email admin@admin.com and password: change-me-soon!. Which you can use to log in the first time.

See our wiki

Before reporiting a problem, please read how to File an issue.

See our roadmap

See the Contributing Guidelines

See the LICENSE file