solidus 2.11.10 → 3.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +87 -66
  3. metadata +20 -19
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 49900704af23ca042e242f8cfc8d14b1781cb26e8b641cbe8bebad429a3a6d33
4
- data.tar.gz: e0bba8f8b2bda88f2961b9e2ed8099140c7f8ab01a3136e86a5c280fc14fa33a
3
+ metadata.gz: 3f1f753d82cebadacc0203f1c5a1eaa74169f623a87465704be0ab977348d83b
4
+ data.tar.gz: a862133856c75f161338e047bb02c2e4a1e6159b15903c70b66c36c893d0f1f4
5
5
  SHA512:
6
- metadata.gz: 92cd392f65a4f39a2f1d67289c84ab05240367c366eda6909d353c3f34b2a9357072f62827b8856e8deb5a36df4cb752d376d72464867cfac6f760550f7326aa
7
- data.tar.gz: 64c91855d8c7e5f426c364b0d79adc54a38a6b736aa7159da1ea52b078a10e2ba6b8841ec784a0933f477b87c1d9330e10d814ab5fd599a760b108962d6eeae8
6
+ metadata.gz: 83265963bf5e698d2b4aad06fe8d5f3e2ae4439667a06ee4dd417d3badb91116faa2adf29e40d670db9e9840f05e0722b03cb4a677d005ba5074dfe36b801684
7
+ data.tar.gz: 637df976a3382c24180d92fd494c039e64eb4d2a02bfbf5cad6a1c88d2fffd92c48ae6076bc9480b156f0c00a0b0eb1cbe868cf939fec00e2f6fc751e17c4fd7
data/README.md CHANGED
@@ -3,6 +3,7 @@
3
3
  # Solidus
4
4
 
5
5
  [![Circle CI](https://circleci.com/gh/solidusio/solidus/tree/master.svg?style=shield)](https://circleci.com/gh/solidusio/solidus/tree/master)
6
+ [![codecov](https://codecov.io/gh/solidusio/solidus/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus/branch/master)
6
7
  [![Gem](https://img.shields.io/gem/v/solidus.svg)](https://rubygems.org/gems/solidus)
7
8
  [![License](http://img.shields.io/badge/license-BSD-yellowgreen.svg)](LICENSE.md)
8
9
  [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
@@ -12,13 +13,13 @@
12
13
  [![Silver Partners on Open Collective](https://opencollective.com/solidus/tiers/silver/badge.svg?label=Silver Partners&color=brightgree)](https://opencollective.com/solidus)
13
14
  [![Gold Partners on Open Collective](https://opencollective.com/solidus/tiers/gold/badge.svg?label=Gold Partners&color=brightgree)](https://opencollective.com/solidus)
14
15
  [![Open Source Helpers](https://www.codetriage.com/solidusio/solidus/badges/users.svg)](https://www.codetriage.com/solidusio/solidus)
15
- [![Slack](http://slack.solidus.io/badge.svg)](http://slack.solidus.io)
16
+ [![Slack](https://shields.io/badge/slack-start_chatting-blue?logo=slack)](http://slack.solidus.io)
16
17
 
17
18
  **A free, open-source ecommerce platform that gives you complete control over your store.**
18
19
 
19
20
  - **Visit our website**: [https://solidus.io/](https://solidus.io/)
20
21
  - **Read our Community Guidelines**: [https://solidus.io/community-guidelines/](https://solidus.io/community-guidelines/)
21
- - **Read our guides**: [https://guides.solidus.io/developers/](https://guides.solidus.io/developers/)
22
+ - **Read our guides**: [https://guides.solidus.io/](https://guides.solidus.io/)
22
23
  - **Join our Slack**: [http://slack.solidus.io/](http://slack.solidus.io/)
23
24
  - **Solidus Security**: [mailing list](https://groups.google.com/forum/#!forum/solidus-security)
24
25
 
@@ -42,12 +43,12 @@ As a community-driven project, Solidus relies on funds and time donated by devel
42
43
  ### Main Contributor & Director
43
44
  At present, Nebulab is the main code contributor and director of Solidus, providing technical guidance and coordinating community efforts and activities.
44
45
 
45
- [![Nebulab](https://nebulab.it/assets/images/public/logo.svg)](https://nebulab.it/)
46
+ [![Nebulab](https://nebulab.com/assets/img/logo-nebulab_gh-dark-light-mode.svg)](https://nebulab.com/)
46
47
 
47
48
  ### Ambassadors
48
49
  Support this project by becoming a Solidus Ambassador. Your logo will show up here with a link to your website. [Become an Ambassador](https://opencollective.com/solidus).
49
50
 
50
- [![Super Good Software](https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2F3bbb1440-727f-11e9-a366-37673cc38cee.png&height=100)](https://supergood.software/)
51
+ [![Super Good Software](https://images.opencollective.com/supergoodsoft/f720462/logo/100.png)](https://supergood.software/)
51
52
  [![Karma Creative](https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2Fab94d2a0-7253-11e9-a366-37673cc38cee.png&height=100)](https://karmacreative.io/)
52
53
  [![ModdedEuros](https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fimages.opencollective.com%2Fmodded-euros%2Ff1a80ae%2Flogo.png&height=100)](https://www.moddedeuros.com)
53
54
 
@@ -63,14 +64,18 @@ Guides](https://guides.solidus.io) for information about the functionality that
63
64
  Solidus provides.
64
65
 
65
66
  Solidus consists of several gems. When you require the `solidus` gem in your
66
- `Gemfile`, Bundler will install all of the gems maintained in this repository:
67
+ `Gemfile`, Bundler will install all of the following gems:
67
68
 
68
69
  - [`solidus_api`](https://github.com/solidusio/solidus/tree/master/api) (RESTful API)
69
- - [`solidus_frontend`](https://github.com/solidusio/solidus/tree/master/frontend) (Cart and storefront)
70
+ - [`solidus_frontend`](https://github.com/solidusio/solidus_frontend) (Cart and storefront)
70
71
  - [`solidus_backend`](https://github.com/solidusio/solidus/tree/master/backend) (Admin area)
71
72
  - [`solidus_core`](https://github.com/solidusio/solidus/tree/master/core) (Essential models, mailers, and classes)
72
73
  - [`solidus_sample`](https://github.com/solidusio/solidus/tree/master/sample) (Sample data)
73
74
 
75
+ While `solidus_frontend` is still present in the meta-gem, it'll be removed in
76
+ Solidus v4.0. For new stores, we recommend using
77
+ [solidus_starter_frontend](https://github.com/solidusio/solidus_starter_frontend).
78
+
74
79
  All of the gems are designed to work together to provide a fully functional
75
80
  ecommerce platform. However, you may only want to use the
76
81
  [`solidus_core`](https://github.com/solidusio/solidus/tree/master/core) gem
@@ -78,21 +83,7 @@ combine it with your own custom frontend, admin interface, and API.
78
83
 
79
84
  ## Demo
80
85
 
81
- Try out Solidus with one-click on Heroku:
82
-
83
- [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/solidusio/solidus-example-app)
84
-
85
- Alternatively, you can use Docker to run a demo on your local machine. Run the
86
- following command to download the image and run it at
87
- [http://localhost:3000](http://localhost:3000).
88
-
89
- ```
90
- docker run --rm -it -p 3000:3000 solidusio/solidus-demo:latest
91
- ```
92
-
93
- The admin interface can be accessed at
94
- [http://localhost:3000/admin/](http://localhost:3000/admin/), the default
95
- credentials are `admin@example.com` and `test123`.
86
+ You can try the live Solidus demo [here.](http://demo.solidus.io/) The admin section can be accessed [here.](http://demo.solidus.io/admin)
96
87
 
97
88
  ## Getting started
98
89
 
@@ -101,51 +92,19 @@ Begin by making sure you have
101
92
  required for Paperclip. (You can install it using [Homebrew](https://brew.sh) if
102
93
  you're on a Mac.)
103
94
 
104
- To add solidus, begin with a Rails 5/6 application and a database configured and
105
- created.
95
+ To add Solidus, begin with a Rails 5.2, 6 or 6.1 application and a database
96
+ configured and created.
106
97
 
107
98
  ### Installing Solidus
108
99
 
109
- <details>
110
- <summary>For Solidus v2.10 and below</summary>
111
-
112
- Add the following to your Gemfile. Skip the `solidus_auth_devise` part
113
- if you want to use a custom authentication system.
114
-
115
- ```ruby
116
- gem 'solidus'
117
- gem 'solidus_auth_devise'
118
- ```
119
-
120
- Run the `bundle` command to install.
121
-
122
- After installing gems, you'll have to run the generator to create necessary
123
- configuration files and migrations.
124
-
125
- ```bash
126
- bin/rails g spree:install
127
- ```
128
- </details>
129
-
130
- <details>
131
- <summary>For Solidus v2.11 (still unreleased) and above</summary>
132
-
133
- Add the following to your Gemfile.
134
-
135
- ```ruby
136
- gem 'solidus'
137
- ```
138
-
139
- Run the `bundle` command to install.
100
+ In your application's root folder run:
140
101
 
141
- After installing gems, you'll have to run the generator to create necessary
142
- configuration files and migrations.
143
-
144
- ```bash
145
- bin/rails g solidus:install
146
- ```
147
- </details>
102
+ ```bash
103
+ bundle add solidus
104
+ bin/rails g solidus:install
105
+ ```
148
106
 
107
+ And follow the prompt's instructions.
149
108
  ### Accessing Solidus Store
150
109
 
151
110
  Start the Rails server with the command:
@@ -154,8 +113,9 @@ Start the Rails server with the command:
154
113
  bin/rails s
155
114
  ```
156
115
 
157
- The [`solidus_frontend`](https://github.com/solidusio/solidus/tree/master/frontend) storefront will be accessible at [http://localhost:3000/](http://localhost:3000/)
158
- and the admin can be found at [http://localhost:3000/admin/](http://localhost:3000/admin/).
116
+ The storefront will be accessible at
117
+ [http://localhost:3000/](http://localhost:3000/) and the admin can be found at
118
+ [http://localhost:3000/admin/](http://localhost:3000/admin/).
159
119
 
160
120
  For information on how to customize your store, check out the [customization guides](https://guides.solidus.io/developers/customizations/overview.html).
161
121
 
@@ -236,6 +196,8 @@ and/or customizations to the Solidus admin. Use at your own risk.
236
196
  cd solidus
237
197
  ```
238
198
 
199
+ ### Without Docker
200
+
239
201
  * Install the gem dependencies
240
202
 
241
203
  ```bash
@@ -254,6 +216,60 @@ and/or customizations to the Solidus admin. Use at your own risk.
254
216
  bin/setup
255
217
  ```
256
218
 
219
+ ### With Docker
220
+
221
+ ```bash
222
+ docker-compose up -d
223
+ ```
224
+
225
+ Wait for all the gems to be installed (progress can be checked through `docker-compose logs -f app`).
226
+
227
+ You can provide the ruby version you want your image to use:
228
+
229
+ ```bash
230
+ docker-compose build --build-arg RUBY_VERSION=2.7 app
231
+ docker-compose up -d
232
+ ```
233
+
234
+ The rails version can be customized at runtime through `RAILS_VERSION` environment variable:
235
+
236
+ ```bash
237
+ RAILS_VERSION='~> 5.0' docker-compose up -d
238
+ ```
239
+
240
+ Running tests:
241
+
242
+ ```bash
243
+ # sqlite
244
+ docker-compose exec app bin/rspec
245
+ # postgres
246
+ docker-compose exec app env DB=postgres bin/rspec
247
+ # mysql
248
+ docker-compose exec app env DB=mysql bin/rspec
249
+ ```
250
+
251
+ Accessing the databases:
252
+
253
+ ```bash
254
+ # sqlite
255
+ docker-compose exec app sqlite3 /path/to/db
256
+ # postgres
257
+ docker-compose exec app env PGPASSWORD=password psql -U root -h postgres
258
+ # mysql
259
+ docker-compose exec app mysql -u root -h mysql -ppassword
260
+ ```
261
+
262
+ In order to be able to access the [sandbox application](#sandbox), just make
263
+ sure to provide the appropriate `--binding` option to `rails server`. By
264
+ default, port `3000` is exposed, but you can change it through `SANDBOX_PORT`
265
+ environment variable:
266
+
267
+ ```bash
268
+ SANDBOX_PORT=4000 docker-compose up -d
269
+ docker-compose exec app bin/sandbox
270
+ docker-compose exec app bin/rails server --binding 0.0.0.0 --port 4000
271
+ ```
272
+
257
273
  ### Sandbox
258
274
 
259
275
  Solidus is meant to be run within the context of Rails application. You can
@@ -281,6 +297,11 @@ data already loaded.
281
297
  bin/sandbox
282
298
  ```
283
299
 
300
+ Depending on your local environment, it may be necessary for you to set environment variables for your RDBMS, namely:
301
+ - `DB_HOST`
302
+ - `DB_USER`
303
+ - `DB_PASSWORD`
304
+
284
305
  If you need to create a Rails 5.2 application for your sandbox, for example
285
306
  if you are still using Ruby 2.4 which is not supported by Rails 6, you can
286
307
  use the `RAILS_VERSION` environment variable.
@@ -312,8 +333,8 @@ You can see the build statuses at
312
333
 
313
334
  #### Run all tests
314
335
 
315
- [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/home) is
316
- required to run the frontend and backend test suites.
336
+ [ChromeDriver](https://chromedriver.chromium.org/downloads) is required to run
337
+ the backend test suites.
317
338
 
318
339
  To execute all of the test specs, run the `bin/build` script at the root of the Solidus project:
319
340
 
@@ -374,4 +395,4 @@ If you want to write an extension for Solidus, you can use the
374
395
  ## Contributing
375
396
 
376
397
  Solidus is an open source project and we encourage contributions. Please read
377
- [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.
398
+ [CONTRIBUTING.md](https://github.com/solidusio/.github/blob/main/CONTRIBUTING.md) before contributing.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: solidus
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.11.10
4
+ version: 3.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Solidus Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-10 00:00:00.000000000 Z
11
+ date: 2023-02-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: solidus_api
@@ -16,70 +16,70 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 2.11.10
19
+ version: 3.3.1
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 2.11.10
26
+ version: 3.3.1
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: solidus_backend
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 2.11.10
33
+ version: 3.3.1
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 2.11.10
40
+ version: 3.3.1
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: solidus_core
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - '='
46
46
  - !ruby/object:Gem::Version
47
- version: 2.11.10
47
+ version: 3.3.1
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - '='
53
53
  - !ruby/object:Gem::Version
54
- version: 2.11.10
54
+ version: 3.3.1
55
55
  - !ruby/object:Gem::Dependency
56
- name: solidus_frontend
56
+ name: solidus_sample
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - '='
60
60
  - !ruby/object:Gem::Version
61
- version: 2.11.10
61
+ version: 3.3.1
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - '='
67
67
  - !ruby/object:Gem::Version
68
- version: 2.11.10
68
+ version: 3.3.1
69
69
  - !ruby/object:Gem::Dependency
70
- name: solidus_sample
70
+ name: solidus_frontend
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - '='
73
+ - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: 2.11.10
75
+ version: 3.3.0.alpha
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - '='
80
+ - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: 2.11.10
82
+ version: 3.3.0.alpha
83
83
  description: Solidus is an open source e-commerce framework for Ruby on Rails.
84
84
  email: contact@solidus.io
85
85
  executables: []
@@ -95,7 +95,8 @@ files:
95
95
  homepage: http://solidus.io
96
96
  licenses:
97
97
  - BSD-3-Clause
98
- metadata: {}
98
+ metadata:
99
+ rubygems_mfa_required: 'true'
99
100
  post_install_message:
100
101
  rdoc_options: []
101
102
  require_paths:
@@ -104,14 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
104
105
  requirements:
105
106
  - - ">="
106
107
  - !ruby/object:Gem::Version
107
- version: 2.5.0
108
+ version: 2.7.0
108
109
  required_rubygems_version: !ruby/object:Gem::Requirement
109
110
  requirements:
110
111
  - - ">="
111
112
  - !ruby/object:Gem::Version
112
113
  version: 1.8.23
113
114
  requirements: []
114
- rubygems_version: 3.1.4
115
+ rubygems_version: 3.3.7
115
116
  signing_key:
116
117
  specification_version: 4
117
118
  summary: Full-stack e-commerce framework for Ruby on Rails.