workarea
Workarea Commerce Platform ================================================================================ [](https://github.com/workarea-commerce/workarea/actions) [](CODE_OF_CONDUCT.md) [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). [Workarea Commerce Cloud](https://www.workarea.com/pages/commerce-cloud) [Documentation](https://developer.workarea.com) [Demo](https://github.com/workarea-commerce/workarea#demo) [Getting Started](https://github.com/workarea-commerce/workarea#getting-started) [Plugins](https://github.com/workarea-commerce/workarea#plugins) [Extension](https://github.com/workarea-commerce/workarea#extension) [Deploying](https://github.com/workarea-commerce/workarea#deploying) [Sites Running Workarea](https://github.com/workarea-commerce/workarea#sites-running-workarea) [Contributing](https://github.com/workarea-commerce/workarea#contributing) [Slack](https://www.workarea.com/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 after installing [Docker](https://www.docker.com/) by running the following command in your terminal: ```bash curl -s https://raw.githubusercontent.com/workarea-commerce/workarea/master/demo/install | bash ``` **If you are using MacOS or Windows, this will require you to increase Docker's memory allocation to at least 4GB**. Go to your Docker preferences, select the advanced tab, and adjust the memory slider. 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 `[email protected]/w0rkArea!`. See the [README](demo/README.md) in the [`demo`](https://github.com/workarea-commerce/workarea/tree/master/demo) directory for more information. Getting Started -------------------------------------------------------------------------------- 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). Then try following [our guide on creating a new Workarea Rails app](https://developer.workarea.com/articles/create-a-new-app.html) If you have any problems, reach out on our [public Slack](https://www.workarea.com/slack). We're happy to help! **Watch the Quickstart Video:** <https://vimeo.com/370085475> 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](https://github.com/workarea-commerce/workarea-api) | Provides APIs for storefront and admin | | [Blog](https://github.com/workarea-commerce/workarea-blog) | Integrated blogging | | [Reviews](https://github.com/workarea-commerce/workarea-reviews) | Adds product reviews | | [Google Analytics](https://github.com/workarea-commerce/workarea-google-analytics) | Integrates GA with Workarea's analytics | | [Paypal](https://github.com/workarea-commerce/workarea-paypal) | Adds Paypal checkout | | [Wish Lists](https://github.com/workarea-commerce/workarea-wish-lists) | Adds customer wish lists | | [Sitemaps](https://github.com/workarea-commerce/workarea-sitemaps) | Autogenerating sitemaps | | [Share](https://github.com/workarea-commerce/workarea-share) | Adds page sharing via social media or email | | [Package Products](https://github.com/workarea-commerce/workarea-package-products) | Allows displaying products as a group in browse and details pages | | [Gift Cards](https://github.com/workarea-commerce/workarea-gift-cards) | Adds Workarea-native digital gift cards | 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). Extension -------------------------------------------------------------------------------- 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). Deploying -------------------------------------------------------------------------------- Workarea is fairly complex application to host, we recommend our [Commerce Cloud](https://www.workarea.com/pages/commerce-cloud) hosting. If you'd like to host on your own, we have some documentation to help: * [Required infrastructure](https://developer.workarea.com/articles/infrastructure.html) * [Configuring Workarea for hosting](https://developer.workarea.com/articles/configuration-for-hosting.html) Sites Running Workarea -------------------------------------------------------------------------------- [The Bouqs](https://bouqs.com) [Sanrio](https://www.sanrio.com) [BHLDN](https://www.bhldn.com) [Reformation](https://www.thereformation.com) [Woodcraft](https://www.woodcraft.com) [Lonely Planet](https://shop.lonelyplanet.com) [Paragon Sports](https://www.paragonsports.com) [Costume Super Center](https://www.costumesupercenter.com) and many more! Contributing -------------------------------------------------------------------------------- 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). ### Looking for how to contribute code? We encourage you to contribute to Workarea! Check out our [articles on contribution](https://developer.workarea.com/articles/contribute-code.html) on [https://developer.workarea.com](https://developer.workarea.com). ### Looking for how to submit a bug? Please check out our [article on how to submit a bug](https://developer.workarea.com/articles/report-a-bug.html) for how to proceed ### Looking for how to report a security vulnerability? Please check out our [security policy](https://developer.workarea.com/articles/security-policy.html) for how to proceed. License -------------------------------------------------------------------------------- Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)