Contents

= MuckEngine

The muck engine is forms the basis for the muck framework and includes basic functionality utilized by the various muck engines.

The easiest way to get started with muck is to generate your application using a template:
  $ rails <your-app> -m http://github.com/jbasdf/rails-templates/raw/master/muck.rb

Add optional functionality with the following command:
  $ rake rails:template LOCATION=http://github.com/jbasdf/rails-templates/raw/master/mucktoo.rb

== Installation

  sudo gem install mislav-will_paginate -s 'http://gems.github.com'
  
  sudo gem install muck-engine

== Setup
Be sure to include the muck_engine tasks in your Rakefile:

  require 'muck_engine'
  require 'muck_engine/tasks'

Add a method to application_controller.rb that will determine which users have access to the admin section of the website
  
  # called by Admin::Muck::BaseController to check whether or not the
  # user should have access to the admin UI
  def admin_access?
    admin?
  end
  
== Layout

The muck template will build your basic application and construct all the needed files and configuration.

If you build your own layout be sure to include the following script in your layout or the javascript in the system won't work:
  <script type="text/javascript" language="JavaScript">
    <%= yield :javascript %>
  </script>

== CSS

The css provided by the muck engine comes from blueprint:
http://www.blueprintcss.org/

We've also included a liquid version:
http://www.ixda.org/discuss.php?post=23298&search=blueprint

And icons:
http://www.ajaxbestiary.com/Labs/SilkSprite/

== Javascript

The muck engine uses jRails and thus jQuery for javascript:
http://ennerchi.com/projects/jrails

jGrowl is optional but included in case you'd like to use it for flash and error messages:
http://www.stanlemon.net/projects/jgrowl.html


Copyright (c) 2009 Justin Ball, released under the MIT license

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
muck-engine-0.1.6	README.rdoc