Skip to content
Workarea is an enterprise-grade Ruby on Rails commerce platform
Ruby HTML JavaScript CSS
Branch: master
Clone or download
Latest commit ba9265a Sep 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Merge branch 'v3.4-stable' Aug 30, 2019
admin Fix "Back To" links in Releases flow Sep 16, 2019
core Merge pull request #64 from workarea-commerce/improvement-43-release-… Sep 17, 2019
docs Add Workarea 3.5 release notes Sep 17, 2019
script Clean up script dir Sep 3, 2019
storefront Update content block helper to use view helper cache method. Sep 13, 2019
testing Remove Search Autocomplete Aug 29, 2019
.editorconfig Initial commit for v3.5 Aug 21, 2019
.eslintrc.json Initial commit for v3.4-stable Aug 21, 2019
.gitignore Remove Search Autocomplete (#16) Aug 28, 2019
.rubocop.yml Update rubocop config to work on latest Aug 30, 2019
.stylelintrc.json Initial commit for v3.4-stable Aug 21, 2019
.travis.yml Initial commit for v3.4-stable Aug 21, 2019
BUILDS.md Add API to builds Sep 3, 2019
CHANGELOG.md Release version 3.4.14 Aug 26, 2019
CODE_OF_CONDUCT.md Initial commit for v3.4-stable Aug 21, 2019
CONTRIBUTING.md Initial commit for v3.4-stable Aug 21, 2019
CONTRIBUTORS.md Add kristenward to contributors Aug 23, 2019
Gemfile Update rubocop config to work on latest Aug 30, 2019
LICENSE Initial commit for v3.4-stable Aug 21, 2019
README.md Update admin configuration options (#49) Sep 11, 2019
Rakefile Update CHANGELOG Aug 26, 2019
SECURITY.md Create SECURITY.md Aug 23, 2019
docker-compose.yml Initial commit for v3.4-stable Aug 21, 2019
package.json Update CI for new shareable CI actions Aug 29, 2019
plugin_template.rb Initial commit for v3.4-stable Aug 21, 2019
workarea.gemspec Initial commit for v3.4-stable Aug 21, 2019
yarn.lock Update CI for new shareable CI actions Aug 29, 2019

README.md

Workarea Commerce Platform

CI Status Contributor Covenant

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
Extension
Deploying
Sites Running Workarea
Contributing
Slack

Workarea Screenshot

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-demo/master/bin/install | bash

This will run a script that does the following:

  • clone the workarea-demo repository.
  • build a Docker image for the application
  • start containers for the application and required services
  • seed the database
  • start the application server

It requires you have Docker installed and running. Once complete, you can visit http://localhost:3000 to view your storefront app. For the Workarea Admin, you can visit 'http://localhost:3000/admin'. The seed data provides an admin user with an email/password of user@workarea.com/w0rkArea!.

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.

  1. Add the workarea gem to the Gemfile in your Rails 5.2 app:

     gem 'workarea', '~> 3.4.6'
    
  2. Install the gems:

     $ bundle install
    
  3. Start the workarea services (uses Docker):

     $ bin/rails workarea:services:up
    
  4. 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.

  5. Run the database seeds:

     $ bin/rails db:seed
    
  6. Run the Rails server:

     $ bin/rails server
    
  7. 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
Package Products Allows displaying products as a group in browse and details pages
Gift Cards Adds Workarea-native digital gift cards

To see a full list of open-source plugins, check out the Workarea Github organization. More plugins like B2B functionality, order management, and running multiple sites are available through the Workarea Commerce Cloud.

Extension

Workarea is meant to be extended and customized to fit merchant needs. It's built as a collection of Rails Engines so the Rails guides on customizing engines apply. Workarea also includes the 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.

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:

Sites Running Workarea

The Bouqs
Sanrio
BHLDN
Reformation
Woodcraft
Lonely Planet
Paragon Sports
Costume Super Center
and many more!

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

You can’t perform that action at this time.