INSTALL

   1 Installation
   2 ============
   3
   4 Instructions for installation:
   5
   6 file: config/init.rb
   7
   8 # add the slice as a regular dependency
   9
  10 dependency 'merb_mart'
  11
  12 # if needed, configure which slices to load and in which order
  13
  14 Merb::Plugins.config[:merb_slices] = { :queue => ["MerbMart", ...] }
  15
  16 # optionally configure the plugins in a before_app_loads callback
  17
  18 Merb::BootLoader.before_app_loads do
  19
  20   Merb::Slices::config[:merb_E_mart] = { ... }
  21
  22 end
  23
  24 file: config/router.rb
  25
  26 # example: /merb_mart/:controller/:action/:id
  27
  28 r.add_slice(:MerbMart)
  29
  30 # example: /foo/:controller/:action/:id
  31
  32 r.add_slice(:MerbMart, 'foo') # same as :path => 'foo'
  33
  34 # example: /:lang/:controller/:action/:id (with :a param set)
  35
  36 r.add_slice(:MerbMart, :path => ':lang', :params => { :a => 'b' })
  37
  38 # example: /:controller/:action/:id
  39
  40 r.slice(:MerbMart)
  41
  42 Normally you should also run the following rake task:
  43
  44 rake slices:merb_E_mart:install
  45
  46 ------------------------------------------------------------------------------
  47
  48 You can put your application-level overrides in:
  49
  50 host-app/slices/merb_mart/app - controllers, models, views ...
  51
  52 Templates are located in this order:
  53
  54 1. host-app/slices/merb_mart/app/views/*
  55 2. gems/merb_mart/app/views/*
  56 3. host-app/app/views/*
  57
  58 You can use the host application's layout by configuring the
  59 merb_mart slice in a before_app_loads block:
  60
  61 Merb::Slices.config[:merb_E_mart] = { :layout => :application }
  62
  63 By default :merb_E_mart is used. If you need to override
  64 stylesheets or javascripts, just specify your own files in your layout
  65 instead/in addition to the ones supplied (if any) in
  66 host-app/public/slices/merb_mart.
  67
  68 In any case don't edit those files directly as they may be clobbered any time
  69 rake merb_E_mart:install is run.
  70
  71 Dependencies
  72 ------------
  73
  74 MerbMart master branch is being built on the cutting-edge Merb framework, and
  75 the bleeding edge DataMapper framework. As such, you'll have to get yourself
  76 setup with those gems before you get the chance to play with MerbMart.
  77
  78 Dependencies for MerbMart:
  79
  80  * **DataMapper 0.9** - 'edge' development
  81     * *DataObjects*
  82         * `git clone git://github.com/sam/do.git`
  83         * `cd data_objects && rake gem && sudo gem install pkg/data_objects-0.9.0.gem`
  84         * install the relevant driver for your database
  85     * *dm-core*
  86         * `git clone git://github.com/sam/dm-core.git`
  87     * *dm-more*
  88         * `git clone git://github.com/sam/dm-more.git`
  89         * *dm-aggregates*
  90         * *dm-is-tree*
  91         * *dm-migrations*
  92         * *dm-timestamps*
  93         * *dm-types*
  94         * *dm-validations*
  95         * *merb\_datamapper*
  96         (NOTE: do not use the *merb\_datamapper* included in the 0.9.2 distribution of
  97          *merb_plugins*, as it was designed for DataMapper 0.3 series)
  98  * **Merb 0.9.3** (or above)
  99     * *merb-core*           : `sudo gem install merb-core`
 100     * *merb-more*           : `sudo gem install merb-more`
 101     * *merb\_plugins*
 102         * *merb\_helpers*   : `sudo gem install merb_helpers`
 103         * *merb\_stories*
 104         (NOTE:> 0.9.3 required. Install from merb\_plugins source.
 105         See merb-plugins issue
 106         [106](http://merb.lighthouseapp.com/projects/7588/tickets/106-merb_stories-require-old-rspec-plugin) )
 107
 108 Running Specs
 109 -------------
 110
 111 To run all specs:
 112
 113     rake spec
 114
 115 You can also run individual groups of specs. To see tasks available to you:
 116
 117     rake -T