opensteam / opensteam

Branches (2)
- development
- master ✓
Tags (1)
- v0.9.4

e-commerce framework for ruby-on-rails — Read more

http://www.opensteam.net

This URL has Read+Write access

* moved Opensteam::Initializer from environment.rb to 
config/initializers/opensteam_initilizer.rb: Now we can use opensteam as a 
plugin.

shm (author)

Sun Mar 22 15:05:47 -0700 2009

commit 4e64a6236ba5fc5adf38f2af3992555f8cc3e396
tree 857b3fa3543d223ae17317577fbf85d459869452
parent 0ed468bfd9a0bd89c4637b49cfc5b949049747a7

opensteam /

	name	age	history message
	.gitignore		Loading commit data...
	.gitmodules
	CHANGELOG
	LICENSE
	Manifest
	README.rdoc
	Rakefile
	generators/
	lib/
	opensteam.gemspec
	test/

README.rdoc

opensteam v1.0.1

Homepage www.opensteam.net
Blog blog.opensteam.net
Github github.com/dd/opensteam
Rubyforge rubyforge.org/projects/opensteam
DiamondDogs Webconsulting www.diamonddogs.cc

AUTHOR:

Michael Schaerfer (shm) @ DiamondDogs Webconsulting

DESCRIPTION:

An eCommerce Framework for Ruby on Rails

CHANGELOG

see CHANGELOG File

INSTALL:

        sudo gem sources -a http://gems.github.com (you only have to do this once)

        sudo gem install shm-opensteam

FEATURES

General Features

generate/implement product and property models
ShoppingCart + Checkout Process
Administration Backend:
Overview and process Orders, Shipments and Invoices
Configure your Products, Properties and Inventory-Items
Configure ShippingRates, Taxes and PaymentTypes
ActiveMerchant Integration

Generators

opensteam provides three new generators (script/generate):

create a new webshop (soon to be replaced by the new Rails Template feature!):
script/generate opensteam <webshop_name>
create a new product model:
script/generate opensteam_product ProductName
create a new property model for products (like ‘Color’ for a ‘Shirt’):
script/generate opensteam_property PropertyName

Flexibility in Products

With the product/property generators you can easily implement your own product model. Each product entry is associated with an inventory-item, giving it a price, a storage, etc. Each product-property association (a blue-shirt, a green-shirt, etc) gets its own inventory-item.

SYNOPSIS:

Create an empty Rails application

        rails name_of_rails_application

Create the openSteam framework

        script/generate opensteam WebshopName

Create product models

        script/generate opensteam_product ProductName

Create property models

        script/generate opensteam_property PropertyName

Goto /admin and configure your products

        usr: admin
        pwd: opensteam

REQUIREMENTS:

rails (..of course)
prawnto gem (used for pdf-export) www.cracklabs.com/prawnto
```
      sudo gem install prawn
```
ActiveMerchant gem (used for credit_card payment) www.activemerchant.org/ sudo gem install activemerchant
plugins in ‘vendor/plugins’ or ‘generators/opensteam/templates/vendor/plugins’

CREDITS:

All plugins in ‘generators/opensteam/templates/vendor/plugins’, (or ‘vendor/plugins’ in the generated webshop) belong to their respective owner. See their LICENSE files for more information.

The admin-backend uses the Ext-JS Framework extjs.com/ . See their License file for more information.

Some of the icons by famfamfam www.famfamfam.com/lab/icons/silk/ .Licensed under a Creative Commons Attribution 2.5 License, creativecommons.org/licenses/by/2.5/

Some of the other icons by www.starfishwebconsulting.co.uk/ecommerce-icons

LICENSE:

opensteam is licensed under the GNU General Public License (GPL) version 2

see the LICENSE file for more information.