README

   1 = merb_mart
   2
   3 merb_mart is an open-source e-commerce engine, developed on top of the recent
   4 Ruby-language Merb MVC framework. Although merb_mart is designed for e-commerce
   5 sites of all sizes, the speed and scalability of the Merb framework make it
   6 suitable for even large online stores.
   7
   8 In addition to Merb framework, merb_mart is also built around the following
   9 open-source projects:
  10   * DataMapper (0.9 branch), for persistence / object relation mapping (ORM).
  11   * RSpec, for behavior driven development (BDD).
  12   * ActiveMerchant, for Credit Card, payment and shipping processing.
  13   as well as attachmerb_fu, merb_paginate,
  14
  15 See INSTALL or the project wiki for a full list of dependencies.
  16
  17 merb_mart is a loose port of the Substruct e-commerce application for Ruby-on-
  18 Rails. The initial 0.1 release of merb_mart will be a feature-equivalent port
  19 of Substruct 0.97. merb_mart borrows many ideas, its database entity design and
  20 some lines of code from Substruct, and is grateful to its developers for
  21 developing such a great tool:
  22   http://code.google.com/p/substruct/
  23   http://substruct.subimage.com/
  24
  25 ** WARNING ** : merb_mart is in very early development stages. At this stage,
  26 the application should be considered only for consumption by advanced Ruby and
  27 Merb developers. If you're looking for something for production consumption,
  28 or not yet ready to jump from Ruby on Rails,  then we would strongly advise
  29 going with Substruct.
  30
  31 ** REQUEST ** : Your development support is very much appreciated. Please
  32 contact us below if you're interested in lending a hand with the development of
  33 this project.
  34
  35 == License
  36
  37 merb_mart is released under the Artistic License, and under GPLv2 (TODO: verify
  38 that Substruct developers have definitely dual-licensed the code). Copyright
  39 information, as well as a copy of the Artistic License may be found in the
  40 LICENSE file.
  41
  42 == Installation and Setup
  43
  44 Please seem the INSTALL file for details on getting up and running with
  45 merb_mart
  46
  47 == Support
  48
  49 ** WARNING REPEATED ** : merb_mart at a very early stage of development. You
  50 should not use this code unless you're reasonably secure with both Ruby and
  51 Merb. That said, please do get involved - and if you're happy to contribute
  52 back with bug reports and patches, then we'll be happy to help you get the
  53 application up and running.
  54
  55 Your best source for support currently is either the wiki, IRC or the mailing
  56 list:
  57
  58     merb_mart Wiki (this is its temporary residence):
  59     http://github.com/myabc/merb_mart/wikis
  60
  61     merb_mart mailing list:
  62     http://groups.google.com/group/merb_mart
  63
  64     merb_mart homepage:
  65     http:// -- coming soon -- /
  66
  67     Contact the developers directly:
  68     - alex@alexcolesportfolio.com | myabc on #datamapper, #merb IRC
  69