forked from drhenner/ror_ecommerce
/
index.html
153 lines (139 loc) · 7.56 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Documentation by YARD 0.6.3</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html" title="Index">Index</a> »
<span class="title">File: README</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'><h1>Project Overview</h1>
<p><a href="http://ror_ecommerce.lighthouseapp.com/home">Please create a ticket if you have issues</a></p>
<p><a href="http://www.ror-e.com">Please look at the homepage for more details: www.ror-e.com</a></p>
<p>This is a Rails e-commerce platform. Other e-commerce projects that
use rails, don’t use rails in a standard way. They use engines or are a separate
framework altogether.</p>
<p><span class="caps">ROR</span> ecommerce is a <strong>Rails 3 application</strong> with the intent to allow developers to create
an ecommerce solution easily. This solution includes, an Admin for <strong>Purchase Orders</strong>,
<strong>Product creation</strong>, <strong>Shipments</strong>, <strong>Fulfillment</strong> and <strong>creating Orders</strong>. There is a minimal
customer facing shopping cart understanding that this will be customized. The cart allows
you to track your customers <strong>cart history</strong> and includes a <strong>double entry accounting system</strong>.</p>
<p>The project has <strong>solr searching</strong>, <strong>compass</strong> and <strong>blueprint for <span class="caps">CSS</span></strong> and uses <strong>jQuery</strong>.
The gem list is quite large and the project still has a large wish list but it is the most
complete solution for Rails today and it will only get better.</p>
<p>Please use <strong>Ruby 1.9.2</strong> and enjoy <strong>Rails 3.0</strong>.</p>
<p>ROR_ecommerce is designed differently. If you understand Rails you will understand ROR_ecommerce.
There is nothing in this project that you wouldn’t see in a normal Rails application. If you don’t like
what is in the project just change it like you would in any other Rails app.</p>
<p>Contributors are welcome. For now email David Henner (<strong>drhenner@yahoo.com</strong>) to see how you
can contribute. (send your patch if you have one.) Soon there will be a bug tracking
system and a formal way to submit your patch.</p>
<p>We will always need help with UI, Documentation and code so feel free to help.</p>
<h2>Getting Started</h2>
<p>We have a google group. Ask question and help answer questions.
<a href="http://groups.google.com/group/ror_ecommerce">ror_ecommerce Google-group</a></p>
<p>install rvm with ruby 1.9.2 or if you have 1.9.2 on your system your good to go</p>
<p>Configure your database.yml file (add the development and test database)</p>
<ol>
<li>Go into config/config.yml and change the encryption_key</li>
</ol><blockquote>
<p>aes = OpenSSL::Cipher::Cipher.new(‘<span class="caps">AES</span>-256-<span class="caps">CBC</span>’)
set_encryption_key_to = aes.random_iv</p>
</blockquote>
<ol>
<li>gem install bundler</li>
<li>bundle install</li>
<li>rake db:create</li>
<li>rake db:migrate</li>
<li>rake db:seed</li>
<li>rake db:test:prepare</li>
<li>git submodule init</li>
<li>git submodule update</li>
<li>gem install compass</li>
<li>gem install fancy-buttons</li>
</ol><p>######compass install -r fancy-buttons -f fancy-buttons</p>
<p>Time to start solr and memcache(yep you better install them)
rake sunspot:solr:start</p>
<p>If you decide not to use solr, go into product.rb and delete the following</p>
<pre class="code"><span class='id searchable'>searchable</span> <span class='kw'>do</span>
<span class='id text'>text</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:default_boost</span> <span class='op'>=></span> <span class='int'>2</span>
<span class='id text'>text</span> <span class='symbol'>:product_keywords</span><span class='comment'>#, :multiple => true
</span> <span class='id text'>text</span> <span class='symbol'>:description</span>
<span class='id time'>time</span> <span class='symbol'>:deleted_at</span>
<span class='kw'>end</span></pre>
<blockquote>
<p>Take a look at setting up solr
<a href="http://github.com/outoftime/sunspot/wiki/adding-sunspot-search-to-rails-in-5-minutes-or-less">Solr in 5 minutes</a></p>
</blockquote>
<blockquote>
<p>memcached -vv ## you can config many other cache stores but
## the cookie store will not work (in the admin) and the DB session store will be a dog</p>
</blockquote>
<p>Need to create config/config.yml and change the encryption key and paypal or auth.net information.
You can also use config/config.yml.example until you get your real info.</p>
<p>Paperclip will throw errors if not configured correctly.
if you are on a Ubuntu machine, change this line in environment.rb:
Paperclip.options[:command_path] = “/usr/local/bin”
into:
Paperclip.options[:command_path] = “/usr/bin”</p>
<p>Once everything is setup, start up the server with ‘rails server’ and direct it to
<strong>localhost:3000/admin/overviews</strong></p>
<p>write down the username/password and follow the directions.</p>
<h2>TODOs:</h2>
<ul>
<li>loyalty credits</li>
<li>coupons</li>
<li>product sales (eg. 20% off)</li>
<li>have breadcrumbs headers by product type and use product_type.parent</li>
<li>move items from and to saved/wish lists</li>
<li>remove specific qty from cart.(method has been created just not in the UI)</li>
</ul>
<h2>Author</h2>
<p>RoR Ecommerce was written by David Henner with contributions from:</p>
<ul>
<li>Oren Golan</li>
<li>Yury Velikanau</li>
</ul>
<h2><span class="caps">FYI</span>:</h2>
<p>Shipping categories are categories based off price:</p>
<p>you might have two shipping categories (light items) & (heavy items)
Have fun!!!</p>
<ul>
<li>I personally want to thank some people I don’t even know.
Ryan Bates and Greg Pollack, I have learned way too much from you 2
it would only be right to give some thanks</li>
<li>I’d also like to Thank one person that I do know.
Umang Chouhan I’ve learned a lot from you also.
(even if I do have to filter out some of what you say. <span class="caps">LOL</span>)</li>
</ul></div></div>
<div id="footer">
Generated on Fri Dec 31 05:35:13 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.3 (ruby-1.9.2).
</div>
</body>
</html>