workarea 3.4.45 → 3.5.0.beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +3 -3
- data/CHANGELOG.md +214 -973
- data/README.md +37 -46
- metadata +13 -13
data/README.md
CHANGED
|
@@ -1,18 +1,20 @@
|
|
|
1
1
|
Workarea Commerce Platform
|
|
2
2
|
================================================================================
|
|
3
|
-
[](https://github.com/workarea-commerce/workarea/actions)
|
|
4
4
|
[](CODE_OF_CONDUCT.md)
|
|
5
5
|
|
|
6
|
-
[Workarea](https://www.workarea.com) is an enterprise-grade commerce platform written in [Ruby on Rails](https://rubyonrails.org). It uses [MongoDB](https://www.mongodb.com), [Elasticsearch](https://www.elastic.co/products/elasticsearch), and [Redis](https://redis.io). Workarea also uses a whole lot of gems you can see in [our gemspec](https://github.com/
|
|
6
|
+
[Workarea](https://www.workarea.com) is an enterprise-grade commerce platform written in [Ruby on Rails](https://rubyonrails.org). It uses [MongoDB](https://www.mongodb.com), [Elasticsearch](https://www.elastic.co/products/elasticsearch), and [Redis](https://redis.io). Workarea also uses a whole lot of gems you can see in [our gemspec](https://github.com/workarea-commerce/workarea/blob/master/core/workarea-core.gemspec).
|
|
7
7
|
|
|
8
|
-
[Workarea Commerce Cloud](https://www.workarea.com/pages/commerce-cloud)
|
|
9
|
-
[Documentation](https://developer.workarea.com)
|
|
10
|
-
[Demo](https://github.com/workarea-commerce/workarea#demo)
|
|
11
|
-
[Getting Started](https://github.com/workarea-commerce/workarea#getting-started)
|
|
12
|
-
[Plugins](https://github.com/workarea-commerce/workarea#plugins)
|
|
13
|
-
[
|
|
14
|
-
[
|
|
15
|
-
[
|
|
8
|
+
[Workarea Commerce Cloud](https://www.workarea.com/pages/commerce-cloud)
|
|
9
|
+
[Documentation](https://developer.workarea.com)
|
|
10
|
+
[Demo](https://github.com/workarea-commerce/workarea#demo)
|
|
11
|
+
[Getting Started](https://github.com/workarea-commerce/workarea#getting-started)
|
|
12
|
+
[Plugins](https://github.com/workarea-commerce/workarea#plugins)
|
|
13
|
+
[Extension](https://github.com/workarea-commerce/workarea#extension)
|
|
14
|
+
[Deploying](https://github.com/workarea-commerce/workarea#deploying)
|
|
15
|
+
[Sites Running Workarea](https://github.com/workarea-commerce/workarea#sites-running-workarea)
|
|
16
|
+
[Contributing](https://github.com/workarea-commerce/workarea#contributing)
|
|
17
|
+
[Slack](https://www.workarea.com/slack)
|
|
16
18
|
|
|
17
19
|

|
|
18
20
|
|
|
@@ -74,46 +76,16 @@ curl -s https://raw.githubusercontent.com/workarea-commerce/workarea/master/demo
|
|
|
74
76
|
|
|
75
77
|
Once complete, you can view the Workarea Storefront at <http://localhost:3000> and the Workarea Admin at <http://localhost:3000/admin>. The seed data provides an admin user with an email/password of `user@workarea.com/w0rkArea!`.
|
|
76
78
|
|
|
77
|
-
See the [README](demo/README.md) in the `demo` directory for more information.
|
|
79
|
+
See the [README](demo/README.md) in the [`demo`](https://github.com/workarea-commerce/workarea/tree/master/demo) directory for more information.
|
|
80
|
+
|
|
78
81
|
|
|
79
82
|
Getting Started
|
|
80
83
|
--------------------------------------------------------------------------------
|
|
84
|
+
We'd suggest checking out our introductory overview article on Workarea to wrap your head around the technology. [Read the Workarea developer overview article](https://developer.workarea.com/articles/overview.html).
|
|
81
85
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
We'll assume you have [Docker desktop](https://www.docker.com/products/docker-desktop) and [Ruby >= 2.4.0, < 2.7.0](https://github.com/rbenv/rbenv#installation) installed.
|
|
85
|
-
|
|
86
|
-
Feel free to refer to
|
|
87
|
-
|
|
88
|
-
1. Add the `workarea` gem to the `Gemfile` in your Rails 5.2 app:
|
|
89
|
-
|
|
90
|
-
gem 'workarea', '~> 3.4.6'
|
|
91
|
-
|
|
92
|
-
2. Install the gems:
|
|
93
|
-
|
|
94
|
-
$ bundle install
|
|
95
|
-
|
|
96
|
-
3. Start the workarea services (uses Docker):
|
|
97
|
-
|
|
98
|
-
$ bin/rails workarea:services:up
|
|
99
|
-
|
|
100
|
-
4. Run the Workarea Rails generator:
|
|
101
|
-
|
|
102
|
-
$ bin/rails generate workarea:install
|
|
103
|
-
|
|
104
|
-
This generator will mount the Workarea engines in `config/routes.rb`, and add Workarea seeds to `db/seeds.rb`.
|
|
86
|
+
Then try following [our guide on creating a new Workarea Rails app](https://developer.workarea.com/articles/create-a-new-app.html)
|
|
105
87
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
$ bin/rails db:seed
|
|
109
|
-
|
|
110
|
-
5. Run the Rails server:
|
|
111
|
-
|
|
112
|
-
$ bin/rails server
|
|
113
|
-
|
|
114
|
-
6. Visit `http://localhost:3000` in a browser and you'll see your Workarea storefront.
|
|
115
|
-
|
|
116
|
-
For more information on getting started, see the [quick start](https://developer.workarea.com/articles/create-a-new-app.html) guide.
|
|
88
|
+
If you have any problems, reach out on our [public Slack](https://www.workarea.com/slack). We're happy to help!
|
|
117
89
|
|
|
118
90
|
|
|
119
91
|
Plugins
|
|
@@ -130,10 +102,17 @@ Workarea extends functionality with a library of plugins. These plugins add ever
|
|
|
130
102
|
| [Wish Lists](https://github.com/workarea-commerce/workarea-wish-lists) | Adds customer wish lists |
|
|
131
103
|
| [Sitemaps](https://github.com/workarea-commerce/workarea-sitemaps) | Autogenerating sitemaps |
|
|
132
104
|
| [Share](https://github.com/workarea-commerce/workarea-share) | Adds page sharing via social media or email |
|
|
133
|
-
| [Google Tag Manager](https://github.com/workarea-commerce/workarea-tag-manager) | Adds [Google Tag Manager](https://marketingplatform.google.com/about/tag-manager/) |
|
|
134
105
|
| [Package Products](https://github.com/workarea-commerce/workarea-package-products) | Allows displaying products as a group in browse and details pages |
|
|
135
106
|
| [Gift Cards](https://github.com/workarea-commerce/workarea-gift-cards) | Adds Workarea-native digital gift cards |
|
|
136
107
|
|
|
108
|
+
To see a full list of open-source plugins, check out the [Workarea Github organization](https://github.com/workarea-commerce). More plugins like B2B functionality, order management, and running multiple sites are available through the [Workarea Commerce Cloud](https://www.workarea.com/pages/commerce-cloud).
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
Extension
|
|
112
|
+
--------------------------------------------------------------------------------
|
|
113
|
+
Workarea is meant to be extended and customized to fit merchant needs. It's built as a collection of [Rails Engines](https://guides.rubyonrails.org/engines.html) so the [Rails guides on customizing engines](https://guides.rubyonrails.org/engines.html#improving-engine-functionality) apply. Workarea also includes the [Rails Decorators](https://github.com/workarea-commerce/rails-decorators) to provide a easy and familiar path for Rails developers to customize Ruby classes. To read more, check out [our documentation on extension](https://developer.workarea.com/articles/extension-overview.html).
|
|
114
|
+
|
|
115
|
+
|
|
137
116
|
Deploying
|
|
138
117
|
--------------------------------------------------------------------------------
|
|
139
118
|
Workarea is fairly complex application to host, we recommend our [Commerce Cloud](https://www.workarea.com/pages/commerce-cloud) hosting.
|
|
@@ -144,6 +123,18 @@ If you'd like to host on your own, we have some documentation to help:
|
|
|
144
123
|
* [Configuring Workarea for hosting](https://developer.workarea.com/articles/configuration-for-hosting.html)
|
|
145
124
|
|
|
146
125
|
|
|
126
|
+
Sites Running Workarea
|
|
127
|
+
--------------------------------------------------------------------------------
|
|
128
|
+
[The Bouqs](https://bouqs.com)
|
|
129
|
+
[Sanrio](https://www.sanrio.com)
|
|
130
|
+
[BHLDN](https://www.bhldn.com)
|
|
131
|
+
[Reformation](https://www.thereformation.com)
|
|
132
|
+
[Woodcraft](https://www.woodcraft.com)
|
|
133
|
+
[Lonely Planet](https://shop.lonelyplanet.com)
|
|
134
|
+
[Paragon Sports](https://www.paragonsports.com)
|
|
135
|
+
[Costume Super Center](https://www.costumesupercenter.com)
|
|
136
|
+
and many more!
|
|
137
|
+
|
|
147
138
|
Contributing
|
|
148
139
|
--------------------------------------------------------------------------------
|
|
149
140
|
All contributors in any way are expected to follow the [code of conduct](https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md).
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: workarea
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.5.0.beta.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ben Crouse
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2019-11-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: workarea-core
|
|
@@ -16,56 +16,56 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - '='
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 3.
|
|
19
|
+
version: 3.5.0.beta.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: 3.
|
|
26
|
+
version: 3.5.0.beta.1
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: workarea-storefront
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
30
30
|
requirements:
|
|
31
31
|
- - '='
|
|
32
32
|
- !ruby/object:Gem::Version
|
|
33
|
-
version: 3.
|
|
33
|
+
version: 3.5.0.beta.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: 3.
|
|
40
|
+
version: 3.5.0.beta.1
|
|
41
41
|
- !ruby/object:Gem::Dependency
|
|
42
42
|
name: workarea-admin
|
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
|
44
44
|
requirements:
|
|
45
45
|
- - '='
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 3.
|
|
47
|
+
version: 3.5.0.beta.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: 3.
|
|
54
|
+
version: 3.5.0.beta.1
|
|
55
55
|
- !ruby/object:Gem::Dependency
|
|
56
56
|
name: workarea-testing
|
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
|
58
58
|
requirements:
|
|
59
59
|
- - '='
|
|
60
60
|
- !ruby/object:Gem::Version
|
|
61
|
-
version: 3.
|
|
61
|
+
version: 3.5.0.beta.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: 3.
|
|
68
|
+
version: 3.5.0.beta.1
|
|
69
69
|
description: Workarea is an enterprise-grade Ruby on Rails commerce platform.
|
|
70
70
|
email:
|
|
71
71
|
- bcrouse@workarea.com
|
|
@@ -93,11 +93,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
93
93
|
version: '0'
|
|
94
94
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
95
95
|
requirements:
|
|
96
|
-
- - "
|
|
96
|
+
- - ">"
|
|
97
97
|
- !ruby/object:Gem::Version
|
|
98
|
-
version:
|
|
98
|
+
version: 1.3.1
|
|
99
99
|
requirements: []
|
|
100
|
-
rubygems_version: 3.
|
|
100
|
+
rubygems_version: 3.0.6
|
|
101
101
|
signing_key:
|
|
102
102
|
specification_version: 4
|
|
103
103
|
summary: The Workarea Commerce Platform
|