Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Update README.md
Damian Legawiec63df820ad08c
diff --git a/README.md b/README.mdindex 2107b9e5e6..f41f3ba6c9 100755--- a/README.md+++ b/README.md@@ -1,42 +1,38 @@-# Spree Commerce+-<a href="https://guides.spreecommerce.org/release_notes/4_1_0.html"><img src="https://spreecommerce.org/wp-content/uploads/2020/03/spree-4_1-mobile-first-customizable-ux-1400x800-0_20.png" /></a>+# Spree Commerce-* Join our Slack at [slack.spreecommerce.org](http://slack.spreecommerce.org/)-* [Contact us](https://spreecommerce.org/contact/) to start a new project or get tech support-* [DEMO](https://spreecommerce.org/spree-commerce-demo-explainer/) of the new Spree UX introduced in Spree 4.1-* [9 good reasons to upgrade to Spree 4.1](https://spreecommerce.org/spree-commerce-4-1-is-now-available-9-reasons-to-upgrade-or-use-it-for-a-new-e-commerce-project/) or use it for a new project* [Success Stories](https://spreecommerce.org/stories/)-* [Integrations](https://spreecommerce.org/integrations/)-* [Extensions](https://github.com/spree/spree#extensions)* [Documentation](http://guides.spreecommerce.org)-* [Roadmap](https://github.com/spree/spree/milestones?direction=asc&sort=due_date&state=open)-* [Maintenance Policy](https://github.com/spree/spree/wiki/Maintenance-Policy)+* [Integrations](https://spreecommerce.org/integrations/)++[](https://badge.fury.io/rb/spree) [](https://circleci.com/gh/spree/spree/tree/master) [](https://codeclimate.com/github/spree/spree/test_coverage) [](http://slack.spreecommerce.org)++**Spree** is a complete open source e-commerce solution built with Ruby on Rails. It was started by Sean Schofield and is now developed by [Spark Solutions][spark]. We're open to [contributions](https://guides.spreecommerce.org/developer/contributing/).-[](https://badge.fury.io/rb/spree) [](https://circleci.com/gh/spree/spree/tree/master)-[](https://codeclimate.com/github/spree/spree)-[](https://codeclimate.com/github/spree/spree/test_coverage)-[](http://slack.spreecommerce.org)+## Key Features-**Spree** is a complete open source e-commerce solution built with Ruby on Rails. It-was started by Sean Schofield and is now developed by [Spark Solutions](http://sparksolutions.co). We're open to [contributions](#contributing).+-Spree consists of several different gems (modules), each of which are maintained-in a single repository and documented in a single set of-[online documentation](http://guides.spreecommerce.org/).+* **[Headless Commerce](https://spreecommerce.org/use-cases/headless-ecommerce-api/)** - build mobile apps or custom storefronts in any technology+* **[PWA](https://spreecommerce.org/use-cases/spree-pwa-progressive-web-application/)** - offline shopping experiences like native mobile apps+* **[Mobile-first Storefront](https://spreecommerce.org/spree-commerce-demo-explainer/)** - modern, ultra fast and responsive storefront designed for great UX as well as SEO+* **Global Commerce** - multi currency and multi language support out of the box, different shipping methods / costs for different regions, advanced tax calculation+* **Multi-Store** - host multiple brands / stores on one Spree instance with different branding, configuration, payment methods, shipping options, product catalogs etc+* **Responsive Admin Panel** - manage and curate products, users, orders, returns, shipments & more+* **Orders** - robust system for orders, shipments, returns and refunds+* **Carts** - comprehensive and advanced discounts system+* **Payments** - over 30 payment provider integration out of the box plus API to integrate any other gateway+* **Run everywhere** - cloud, VPS, Docker, Kubernetes+* **Battle Tested** - used by thousands of merchants around the globe in all categories since 2007!+* **Fully customizable** - pick and choose parts you want to use and customize everything else (storefront, order processing, API, etc) to create unique solutions that your business requires+* **More features available via extensions** - dozens of extensions built by community, ready for use for free!-* **spree_api** ([REST API v2](https://guides.spreecommerce.org/api/v2) with [JavaScript / TypeScript SDK](https://github.com/spree/spree-storefront-api-v2-js-sdk) and [REST API v1](https://guides.spreecommerce.org/api/))-* **spree_graphql** (GraphQL API - [coming soon](https://github.com/spree/spree/issues/9176))-* **spree_frontend** (mobile-first, blazing fast and customizable storefront)-* **spree_backend** (feature rich Admin Panel)-* **spree_cmd** (command-line tools for developers)-* **spree_core** (models, services & mailers, the basic components of Spree)-* **spree_sample** (sample data for demo purposes)+## Demo-Go to: https://demo.spreecommerce.org/-Explore demo features: https://spreecommerce.org/spree-commerce-demo-explainer/+See Spree in action: [demo.spreecommerce.org](https://demo.spreecommerce.org/)Or fire up your own demo on Heroku:@@ -47,7 +43,7 @@ Admin panel credentials for your own Heroku demo:* login: `[email protected]`* password: `spree123`-## Local Installation+## Installation### Option A - use Spree Starter with Docker@@ -56,63 +52,25 @@ Admin panel credentials for your own Heroku demo:3. Unzip it4. Run `bin/setup` in `spree_starter-main` directory-### Option B - add Spree to an existing application+### Option B - add Spree to an existing Ruby on Rails application-1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/tutorials/existing_app_tutorial.html)+1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/advanced/existing_app_tutorial.html)-## Extensions+## Documentation-Spree Extensions provide additional features not present in the Core system.--| Extension | Spree 3.2+ support | Description |-| --- | --- | --- |-| [spree_analytics_trackers](https://github.com/spree-contrib/spree_analytics_trackers) | [](https://travis-ci.org/spree-contrib/spree_analytics_trackers) | Adds support for Analytics Trackers (Google Analytics & Segment)-| [spree_avatax_official](https://github.com/spree-contrib/spree_avatax_official) | [](https://travis-ci.org/spree-contrib/spree_avatax_official) | Improve your Spree store's sales tax decision automation with Avalara AvaTax-| [spree_auth_devise](https://github.com/spree/spree_auth_devise) | [](https://travis-ci.org/spree/spree_auth_devise) | Provides authentication services for Spree, using the Devise gem.-| [better_spree_paypal_express](https://github.com/spree-contrib/better_spree_paypal_express) | [](https://travis-ci.org/spree-contrib/better_spree_paypal_express) | This is the official Paypal Express extension for Spree.-| [spree_braintree_vzero](https://github.com/spree-contrib/spree_braintree_vzero) | [](https://travis-ci.org/spree-contrib/spree_braintree_vzero) | Official Spree Braintree v.zero + PayPal extension |-| [spree_contact_us](https://github.com/spree-contrib/spree_contact_us) | [](https://travis-ci.org/spree-contrib/spree_contact_us) | Adds Contact Us form |-| [spree_digital](https://github.com/spree-contrib/spree_digital) | [](https://travis-ci.org/spree-contrib/spree_digital) | A Spree extension to enable downloadable products |-| [spree_gateway](https://github.com/spree/spree_gateway) | [](https://travis-ci.org/spree/spree_gateway) | Payment Gateways (Stripe, Apple Pay, Braintree, Authorize.net and many others)-| [spree_editor](https://github.com/spree-contrib/spree_editor) | [](https://travis-ci.org/spree-contrib/spree_editor) | Rich text editor for Spree with Image and File uploading in-place |-| [spree_globalize](https://github.com/spree-contrib/spree_globalize) | [](https://travis-ci.org/spree-contrib/spree_globalize) | Adds support for model translations (multi-language stores)-| [spree_i18n](https://github.com/spree-contrib/spree_i18n) | [](https://travis-ci.org/spree-contrib/spree_i18n) | I18n translation files for Spree Commerce-| [spree-mollie-gateway](https://github.com/mollie/spree-mollie-gateway) | [](https://github.com/mollie/spree-mollie-gateway) | Official [Mollie](https://www.mollie.com) payment gateway for Spree Commerce. |-| [spree-multi-domain](https://github.com/spree-contrib/spree-multi-domain) | [](https://travis-ci.org/spree-contrib/spree-multi-domain) | Multiple Spree stores on different domains - single unified backed for processing orders-| [spree_multi_vendor](https://github.com/spree-contrib/spree_multi_vendor) | [](https://travis-ci.org/spree-contrib/spree_multi_vendor) | Spree Multi Vendor Marketplace extension |-| [spree-product-assembly](https://github.com/spree-contrib/spree-product-assembly) | [](https://travis-ci.org/spree-contrib/spree-product-assembly) | Product Bundles |-| [spree_recently_viewed](https://github.com/spree-contrib/spree_recently_viewed) | [](https://travis-ci.org/spree-contrib/spree_recently_viewed) | Recently viewed products in Spree |-| [spree_related_products](https://github.com/spree-contrib/spree_related_products) | [](https://travis-ci.org/spree-contrib/spree_related_products) | Related products extension for Spree-| [spree_social](https://github.com/spree-contrib/spree_social) |[](https://travis-ci.org/spree-contrib/spree_social) | Building block for spree social networking features (provides authentication and account linkage) |-| [spree_sitemap](https://github.com/spree-contrib/spree_sitemap) | [](https://travis-ci.org/spree-contrib/spree_sitemap) | Sitemap Generator for Spree |-| [spree_shared](https://github.com/spree-contrib/spree_shared) | [](https://travis-ci.org/spree-contrib/spree_shared) | Multi-tenancy for Spree using Apartment (per tenant databases) |-| [spree_static_content](https://github.com/spree-contrib/spree_static_content) | [](https://travis-ci.org/spree-contrib/spree_static_content) | Manage static pages for Spree |-| [spree_volume_pricing](https://github.com/spree-contrib/spree_volume_pricing) | [](https://travis-ci.org/spree-contrib/spree_volume_pricing) | It determines the price for a particular product variant with predefined ranges of quantities-| [spree_wishlist](https://github.com/spree-contrib/spree_wishlist) | [](https://travis-ci.org/spree-contrib/spree_wishlist) | Wishlist extension for Spree |--## Developing Spree--Please [follow this guide](https://guides.spreecommerce.org/developer/tutorials/developing_spree.html)+[Go to Spree Guides](https://guides.spreecommerce.org/)-## Contributing+## Extensions-Spree is an open source project and we encourage contributions. Please review the-[contributing guidelines](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md)-before contributing.+Extensions provide additional features and integrations for your Spree store-In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.+[Go to Extensions Directory](https://guides.spreecommerce.org/extensions/)++## Contributing-Here are some ways **you** can contribute:+Spree is an open source project and we love contributions in any form - pull requests, issues, feature ideas!-* by using prerelease versions / master branch-* by reporting [bugs](https://github.com/spree/spree/issues/new)-* by [translating to a new language](https://github.com/spree/spree_i18n/tree/master/config/locales)-* by writing or editing [documentation](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md)-* by writing [specs](https://github.com/spree/spree/labels/need_specs)-* by writing [needed code](https://github.com/spree/spree/labels/feature_request) or [finishing code](https://github.com/spree/spree/labels/address_feedback)-* by [refactoring code](https://github.com/spree/spree/labels/address_feedback)-* by reviewing [pull requests](https://github.com/spree/spree/pulls)-* by verifying [issues](https://github.com/spree/spree/labels/unverified)+Please review the [Contributing Guide](https://guides.spreecommerce.org/developer/contributing/)## License@@ -127,4 +85,4 @@ Spree is released under the [New BSD License](https://github.com/spree/spree/bloWe are passionate about open source software.We are [available for hire][spark].-[spark]:http://sparksolutions.co?utm_source=github+[spark]:https://sparksolutions.co?utm_source=github