dup_spree 1.3.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.md +197 -0
  2. data/lib/sandbox.sh +9 -0
  3. data/lib/spree.rb +5 -0
  4. metadata +146 -0
@@ -0,0 +1,197 @@
1
+ **THIS README IS FOR THE MASTER BRANCH OF SPREE AND REFLECTS THE WORK CURRENTLY EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF
2
+ SPREE, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.**
3
+
4
+ SUMMARY
5
+ -------
6
+
7
+
8
+ Spree is a complete open source e-commerce solution built with Ruby on Rails. It was originally developed by Sean Schofield
9
+ and is now maintained by a dedicated [core team](http://spreecommerce.com/core-team). You can find out more
10
+ by visiting the [Spree e-commerce project page](http://spreecommerce.com).
11
+
12
+ Spree actually consists of several different gems, each of which are maintained in a single repository and documented
13
+ in a single set of [online documentation](http://spreecommerce.com/documentation). By requiring the Spree gem you
14
+ automatically require all of the necessary gem dependencies which are:
15
+
16
+ * spree_api
17
+ * spree_cmd
18
+ * spree_core
19
+ * spree_dash
20
+ * spree_promo
21
+ * spree_sample
22
+
23
+ All of the gems are designed to work together to provide a fully functional e-commerce platform. It is also possible,
24
+ however, to use only the pieces you are interested in. So for example, you could use just the barebones spree\_core gem
25
+ and perhaps combine it with your own custom promotion scheme instead of using spree_promo.
26
+
27
+ [![Build Status](https://secure.travis-ci.org/spree/spree.png?branch=1-3-stable)](https://travis-ci.org/spree/spree)
28
+ [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/spree/spree)
29
+
30
+ Installation
31
+ ------------
32
+
33
+ The fastest way to get started is by using the spree command line tool
34
+ available in the spree gem which will add Spree to an existing Rails application.
35
+
36
+ $ gem install rails -v 3.2.9
37
+ $ gem install spree
38
+ $ rails _3.2.9_ new my_store
39
+ $ spree install my_store
40
+
41
+ This will add the Spree gem to your Gemfile, create initializers, copy migrations and
42
+ optionally generate sample products and orders.
43
+
44
+ If you get an "Unable to resolve dependencies" error when installing the Spree gem then you can try installing just the spree_cmd gem which should avoid any circular dependency issues.
45
+
46
+ $ gem install spree_cmd
47
+
48
+ To auto accept all prompts while running the install generator, pass -A as an option
49
+
50
+ $ spree install my_store -A
51
+
52
+ Using the Gem
53
+ -------------
54
+
55
+ You can manually add Spree to your Rails 3.2.x application. Add Spree to
56
+ your Gemfile.
57
+
58
+ ```ruby
59
+ gem 'spree', :git => 'git://github.com/spree/spree.git'
60
+ ```
61
+
62
+ Update your bundle
63
+
64
+ $ bundle install
65
+
66
+ Use the install generator to copy migrations, initializers and generate
67
+ sample data.
68
+
69
+ $ rails g spree:install
70
+
71
+ You can avoid running migrations or generating seed and sample data
72
+
73
+ $ rails g spree:install --migrate=false --sample=false --seed=false
74
+
75
+ You can always perform the steps later.
76
+
77
+ $ bundle exec rake db:migrate
78
+ $ bundle exec rake db:seed
79
+
80
+ To manually load sample products, orders, etc., run the following rake task
81
+
82
+ $ bundle exec rake spree_sample:load
83
+
84
+ Browse Store
85
+ ------------
86
+
87
+ http://localhost:nnnn
88
+
89
+ Browse Admin Interface
90
+ ----------------------
91
+
92
+ http://localhost:nnnn/admin
93
+
94
+
95
+
96
+ Working with the edge source (latest and greatest features)
97
+ -----------------------------------------------------------
98
+
99
+ The source code is essentially a collection of gems. Spree is meant to be run within the context of Rails application. You can easily create a sandbox application inside of your cloned source directory for testing purposes.
100
+
101
+
102
+ 1. Clone the Git repo
103
+
104
+ $ git clone git://github.com/spree/spree.git
105
+ $ cd spree
106
+
107
+ 2. Install the gem dependencies
108
+
109
+ $ bundle install
110
+
111
+ 3. Create a sandbox Rails application for testing purposes (and automatically perform all necessary database setup)
112
+
113
+ $ bundle exec rake sandbox
114
+
115
+ 4. Start the server
116
+
117
+ $ cd sandbox
118
+ $ rails server
119
+
120
+ Performance
121
+ -----------
122
+
123
+ You may noticed that your Spree store runs slowly in development mode. This is a side-effect of how Rails works in development mode which is to continuous reload your Ruby objects on each request. The introduction of the asset pipeline in Rails 3.1 made default performance in development mode significantly worse. There are, however, a few tricks to speeding up performance in development mode.
124
+
125
+ You can recompile your assets as follows:
126
+
127
+ $ bundle exec rake assets:precompile:nondigest
128
+
129
+ If you want to remove precompiled assets (recommended before you commit to Git and push your changes) use the following rake task:
130
+
131
+ $ bundle exec rake assets:clean
132
+
133
+ Use Dedicated Spree Devise Authentication
134
+ -----------------------------------------
135
+ Add the following to your Gemfile
136
+
137
+ $ gem 'spree_auth_devise', :git => 'git://github.com/spree/spree_auth_devise'
138
+
139
+ Then run `bundle install`. Authentication will then work exactly as it did in previous versions of Spree.
140
+
141
+ This line is automatically added by the `spree install` command.
142
+
143
+ If you're installing this in a new Spree 1.2+ application, you'll need to install and run the migrations with
144
+
145
+ $ bundle exec rake spree_auth:install:migrations
146
+ $ bundle exec rake db:migrate
147
+
148
+ change the following line in `config/initializers/spree.rb`
149
+ ```ruby
150
+ Spree.user_class = "Spree::LegacyUser"
151
+ ```
152
+ to
153
+ ```ruby
154
+ Spree.user_class = "Spree::User"
155
+ ```
156
+
157
+ In order to set up the admin user for the application you should then run:
158
+
159
+ $ bundle exec rake spree_auth:admin:create
160
+
161
+
162
+ Running Tests
163
+ -------------
164
+
165
+ Each gem contains its own series of tests, and for each directory, you need to do a quick one-time
166
+ creation of a test application and then you can use it to run the tests. For example, to run the
167
+ tests for the core project.
168
+
169
+ $ cd core
170
+ $ bundle exec rake test_app
171
+
172
+ If you're working on multiple facets of Spree, you may want
173
+ to run this command at the root of the Spree project to
174
+ generate test applications for all the facets:
175
+
176
+ $ bundle exec rake test_app
177
+
178
+ You can run all of the tests inside a facet by also running
179
+ this command:
180
+
181
+ $ cd core
182
+ $ bundle exec rake
183
+
184
+ If you want to run specs for only a single spec file
185
+
186
+ $ bundle exec rspec spec/models/state_spec.rb
187
+
188
+ If you want to run a particular line of spec
189
+
190
+ $ bundle exec rspec spec/models/state_spec.rb:7
191
+
192
+ Travis, the continuous integration service, runs the test suite for each gem one at a time, using the same commands as contained within [`build.sh`](https://github.com/spree/spree/tree/master/build.sh).
193
+
194
+ Contributing
195
+ ------------
196
+
197
+ Spree is an open source project and we encourage contributions. Please see the [contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html) before contributing.
@@ -0,0 +1,9 @@
1
+ # Used in the sandbox rake task in Rakefile
2
+ #!/bin/bash
3
+ rm -rf sandbox
4
+ rails new sandbox --skip-bundle
5
+ cd sandbox
6
+ echo "gem 'spree', :path => '..'" >> Gemfile
7
+ echo "gem 'spree_auth_devise', :github => 'spree/spree_auth_devise', :branch => 'edge'" >> Gemfile
8
+ bundle install --gemfile Gemfile
9
+ rails g spree:install --auto-accept --user_class=Spree::User
@@ -0,0 +1,5 @@
1
+ require 'spree_core'
2
+ require 'spree_api'
3
+ require 'spree_dash'
4
+ require 'spree_promo'
5
+ require 'spree_sample'
metadata ADDED
@@ -0,0 +1,146 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dup_spree
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.3.0.rc1
5
+ prerelease: 6
6
+ platform: ruby
7
+ authors:
8
+ - Sean Schofield
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-12-09 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: dup_spree_core
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - '='
20
+ - !ruby/object:Gem::Version
21
+ version: 1.3.0.rc1
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - '='
28
+ - !ruby/object:Gem::Version
29
+ version: 1.3.0.rc1
30
+ - !ruby/object:Gem::Dependency
31
+ name: dup_spree_api
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - '='
36
+ - !ruby/object:Gem::Version
37
+ version: 1.3.0.rc1
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - '='
44
+ - !ruby/object:Gem::Version
45
+ version: 1.3.0.rc1
46
+ - !ruby/object:Gem::Dependency
47
+ name: dup_spree_dash
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - '='
52
+ - !ruby/object:Gem::Version
53
+ version: 1.3.0.rc1
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - '='
60
+ - !ruby/object:Gem::Version
61
+ version: 1.3.0.rc1
62
+ - !ruby/object:Gem::Dependency
63
+ name: dup_spree_sample
64
+ requirement: !ruby/object:Gem::Requirement
65
+ none: false
66
+ requirements:
67
+ - - '='
68
+ - !ruby/object:Gem::Version
69
+ version: 1.3.0.rc1
70
+ type: :runtime
71
+ prerelease: false
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - '='
76
+ - !ruby/object:Gem::Version
77
+ version: 1.3.0.rc1
78
+ - !ruby/object:Gem::Dependency
79
+ name: dup_spree_promo
80
+ requirement: !ruby/object:Gem::Requirement
81
+ none: false
82
+ requirements:
83
+ - - '='
84
+ - !ruby/object:Gem::Version
85
+ version: 1.3.0.rc1
86
+ type: :runtime
87
+ prerelease: false
88
+ version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - '='
92
+ - !ruby/object:Gem::Version
93
+ version: 1.3.0.rc1
94
+ - !ruby/object:Gem::Dependency
95
+ name: dup_spree_cmd
96
+ requirement: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - '='
100
+ - !ruby/object:Gem::Version
101
+ version: 1.3.0.rc1
102
+ type: :runtime
103
+ prerelease: false
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - '='
108
+ - !ruby/object:Gem::Version
109
+ version: 1.3.0.rc1
110
+ description: ! 'Spree is an open source e-commerce framework for Ruby on Rails. Join
111
+ us on the spree-user google group or in #spree on IRC'
112
+ email: sean@spreecommerce.com
113
+ executables: []
114
+ extensions: []
115
+ extra_rdoc_files: []
116
+ files:
117
+ - README.md
118
+ - lib/sandbox.sh
119
+ - lib/spree.rb
120
+ homepage: http://spreecommerce.com
121
+ licenses:
122
+ - BSD-3
123
+ post_install_message:
124
+ rdoc_options: []
125
+ require_paths:
126
+ - lib
127
+ required_ruby_version: !ruby/object:Gem::Requirement
128
+ none: false
129
+ requirements:
130
+ - - ! '>='
131
+ - !ruby/object:Gem::Version
132
+ version: 1.8.7
133
+ required_rubygems_version: !ruby/object:Gem::Requirement
134
+ none: false
135
+ requirements:
136
+ - - ! '>='
137
+ - !ruby/object:Gem::Version
138
+ version: 1.3.6
139
+ requirements:
140
+ - none
141
+ rubyforge_project:
142
+ rubygems_version: 1.8.24
143
+ signing_key:
144
+ specification_version: 3
145
+ summary: Full-stack e-commerce framework for Ruby on Rails.
146
+ test_files: []