Workarea Commerce Platform
Workarea is an enterprise-grade commerce platform written in Ruby on Rails. It uses MongoDB, Elasticsearch, and Redis. Workarea also uses a whole lot of gems you can see in our gemspec.
Workarea Commerce Cloud Documentation Demo Getting Started Plugins Deploying Contributing Slack
Features
Workarea combines commerce, content, search, and insights into a unified platform to enable merchants to move faster and work smarter. Out-of-the-box features include:
Storefront
- Mobile-first frontend
- Localization support
- First-class SEO
- Built-in analytics
- Cart and checkout
- Customer accounts
- Discounts
- Basic taxes
- Shipping services
Content
- Responsive CMS
- Asset management
- Localized content
- Intelligent merchandising
- Content-based navigation
Search
- Product search
- Search-driven categories
- Filtering and sorting
- Search merchandising
- Results tuning
- Advanced reporting
Insights
- Robust dashboards
- Sales reports
- Trending reports
- Search reports
- Advanced insights
Admin
- Site planning and automation
- Workflows for common tasks
- Inline insights
- Search-first administration
- Commenting
- Audit logs for changes
Demo
You can run a demo version of workarea by running the following command in your terminal:
curl -s https://raw.githubusercontent.com/workarea-commerce/workarea/master/demo/install | bash
It requires you have Docker installed and running. Once complete, you can visit http://localhost:3000
to view your app.
The seed data provides an admin user with an email/password of [email protected]/w0rkArea!
.
See the README in the demo
directory for more information.
For more information on usage and troubleshooting, see the workarea-demo page.
Getting Started
We'll assume you have Docker desktop and Ruby >= 2.4.0, < 2.7.0 installed.
Add the
workarea
gem to theGemfile
in your Rails 5.2 app:gem 'workarea', '~> 3.4.6'
Install the gems:
$ bundle install
Start the workarea services (uses Docker):
$ bin/rails workarea:services:up
Run the Workarea Rails generator:
$ bin/rails generate workarea:install
This generator will mount the Workarea engines in config/routes.rb
, and add Workarea seeds to db/seeds.rb
.
Run the database seeds:
$ bin/rails db:seed
Run the Rails server:
$ bin/rails server
Visit
http://localhost:3000
in a browser and you'll see your Workarea storefront.
For more information on getting started, see the quick start guide.
Plugins
Workarea extends functionality with a library of plugins. These plugins add everything from additional content blocks, to wish lists, to payment gateway integrations and more. Here are some of the most popular plugins:
Plugin | Description |
---|---|
API | Provides APIs for storefront and admin |
Blog | Integrated blogging |
Reviews | Adds product reviews |
Google Analytics | Integrates GA with Workarea's analytics |
Paypal | Adds Paypal checkout |
Wish Lists | Adds customer wish lists |
Sitemaps | Autogenerating sitemaps |
Share | Adds page sharing via social media or email |
Google Tag Manager | Adds Google Tag Manager |
Package Products | Allows displaying products as a group in browse and details pages |
Gift Cards | Adds Workarea-native digital gift cards |
Deploying
Workarea is fairly complex application to host, we recommend our Commerce Cloud hosting.
If you'd like to host on your own, we have some documentation to help:
Contributing
All contributors in any way are expected to follow the code of conduct.
Looking for how to contribute code?
We encourage you to contribute to Workarea! Check out our articles on contribution on https://developer.workarea.com.
Looking for how to submit a bug?
Please check out our article on how to submit a bug for how to proceed
Looking for how to report a security vulnerability?
Please check out our security policy for how to proceed.
License
Workarea Commerce Platform is released under the Business Software License