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

Setup

Be sure to include the muck_engine tasks in your Rakefile:

  require 'muck_engine'
  require 'muck_engine/tasks'

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>

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

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

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