README.markdown

   1 MerbMart README
   2 ===============
   3
   4 MerbMart is an *open-source e-commerce application*, developed on top of the
   5 recent Ruby-language Merb MVC framework. Although MerbMart is designed for
   6 e-commerce sites of all sizes, the speed and scalability of the Merb framework
   7 make it scalable even for large online vendors.
   8
   9 In addition to Merb framework, the following technologies and frameworks
  10 provide a foundation for MerbMart:
  11
  12  * **DataMapper** (bleeding-edge 0.9), for object relation mapping (ORM) and
  13    persistence.
  14  * **RSpec**, for behavio(u)r driven development (BDD).
  15  * **ActiveMerchant**, for Credit Card, payment and shipping processing.
  16    as well as attachmerb\_fu, merb\_paginate.
  17
  18 See INSTALL or the project wiki for a full list of dependencies.
  19
  20 MerbMart is inspired by other, Rails based e-commerce applications, including
  21 [Substruct][substruct] and [Spree][spree]. Although MerbMart started out as a
  22 project to port Substruct to Merb, the initial 0.1 release of MerbMart will
  23 instead be a its own implementation of an e-commerce engine, trying to match
  24 the feature sets other e-commerce applications, but taking advantages of the
  25 unique features of Merb and DataMapper.
  26
  27 Developer Notes
  28 ---------------
  29
  30 **WARNING** : MerbMart is at a very early development stages. At this stage,
  31 the application should be considered only for consumption by advanced Ruby and
  32 Merb developers. If you're looking for something for production consumption,
  33 or not yet ready to jump from Ruby on Rails, then we would strongly advise
  34 trying [Substruct][substruct] or [Spree][spree].
  35
  36 **REQUEST** : Your development support is very much appreciated. Please
  37 contact us below if you're interested in lending a hand with the development
  38 of this project. Or alternatively, clone the code, fork it, create some
  39 patches and let us know when you're done.
  40
  41 Getting the Source
  42 ------------------
  43
  44 Performing a git clone on either of the following repositories will get you
  45 the latest source:
  46
  47     git clone git://github.com/myabc/merb_mart.git
  48     git clone git://gitorious.org/merb_mart/mainline.git (on gitorious)
  49
  50 The following additional mirrors are available:
  51
  52     git://repo.or.cz/merb_mart.git
  53     http://repo.or.cz/r/merb_mart.git
  54
  55 Installation and Setup
  56 ----------------------
  57
  58 Please see the INSTALL file for details on getting up and running with MerbMart.
  59
  60 Copyright and License
  61 ---------------------
  62
  63 MerbMart is licensed under the **GNU Public License (GPL)**:
  64
  65    > Copyright (C) 2008  Alex Coles
  66
  67    > This program is free software: you can redistribute it and/or modify
  68    > it under the terms of the GNU General Public License as published by
  69    > the Free Software Foundation, either version 2 of the License, or
  70    > (at your option) any later version.
  71
  72    > This program is distributed in the hope that it will be useful,
  73    > but WITHOUT ANY WARRANTY; without even the implied warranty of
  74    > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  75    > GNU General Public License for more details.
  76
  77    > You should have received a copy of the GNU General Public License
  78    > along with this program.  If not, see <http://www.gnu.org/licenses/>.
  79
  80 A copy of the GPL License may be found in the GPL-LICENSE, included with
  81 the distribution.
  82
  83 Support
  84 -------
  85
  86 **WARNING REPEATED** : MerbMart is still at a very early stage of its
  87 development. You should not use this code unless you're reasonably secure with
  88 the Ruby language, and the DataMapper and Merb frameworks. That said, _please
  89 do get involved_ - and if you're happy to contribute back with bug reports and
  90 patches, then we'll be happy to help you get the application up and running.
  91
  92 Your best source for support currently is either the wiki, IRC or the mailing
  93 list:
  94
  95  * **MerbMart Wiki** (this is its temporary residence):
  96     http://github.com/myabc/merb_mart/wikis
  97  * **MerbMart mailing list**:
  98     <http://groups.google.com/group/merb_mart>
  99  * **MerbMart homepage**: _coming soon_
 100  * Contact the developers directly:
 101     - <alex@alexcolesportfolio.com> | myabc on #datamapper, #merb IRC
 102
 103 [substruct]:http://code.google.com/p/substruct/ "Substruct e-commerce project"
 104 [spree]:http://spreehq.org/ "Spree Online Commerce for Ruby on Rails"