README.md

   1 <a href="https://spreecommerce.org">
   2    <img src="https://raw.githubusercontent.com/spree/spree/master/guides/src/images/features/spree_header%402x.png" alt="Spree Commerce - complete open source e-commerce solution built with Ruby on Rails. PWA, Global Commerce, Headless Commerce" />
   3 </a>
   4
   5 # Spree Commerce
   6
   7 * [Success Stories](https://spreecommerce.org/stories/)
   8 * [Documentation](http://guides.spreecommerce.org)
   9 * [Integrations](https://spreecommerce.org/integrations/)
  10 * [Join our Slack community](http://slack.spreecommerce.org/)
  11 * [Support](https://guides.spreecommerce.org/support)
  12
  13 [![Gem Version](https://badge.fury.io/rb/spree.svg)](https://badge.fury.io/rb/spree) [![Circle CI](https://circleci.com/gh/spree/spree.svg?style=shield)](https://circleci.com/gh/spree/spree/tree/master) [![Test Coverage](https://api.codeclimate.com/v1/badges/8277fc2bb0b1f777084f/test_coverage)](https://codeclimate.com/github/spree/spree/test_coverage)
  14
  15 **Spree** is a complete open source e-commerce solution for global brands. 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/).
  16
  17 ## Key Features
  18
  19 ![admin panel](guides/src/images/features/admin_panel_978@2x.jpg)
  20
  21 * **[Headless Commerce](https://spreecommerce.org/use-cases/headless-ecommerce-api/)** - build mobile apps or custom storefronts in any technology, [JS/TS SDK available](https://github.com/spree/spree-storefront-api-v2-js-sdk)
  22 * **[PWA](https://spreecommerce.org/use-cases/spree-pwa-progressive-web-application/)** - offline shopping experiences like native mobile apps
  23 * **[Mobile-first Storefront](https://spreecommerce.org/spree-commerce-demo-explainer/)** - modern, ultra fast and responsive storefront designed for great UX as well as SEO
  24 * **[Global Commerce](https://spreecommerce.org/use-cases/international-sales-demo/)** - multi currency and multi language support out of the box, different shipping methods / costs for different regions, advanced tax calculation
  25 * **Multi-Store** - host multiple brands / stores on one Spree instance with different branding, configuration, payment methods, shipping options, product catalogs etc
  26 * **[Multi-vendor marketplace](https://spreecommerce.org/use-cases/multi-vendor-marketplace-demo/)** - run your own marketplace with multiple suppliers with dedicated Supplier Dashboard
  27 * **Responsive Admin Panel** - manage and curate products, users, orders, returns, shipments & more
  28 * **Orders** - robust system for orders, shipments, returns and refunds
  29 * **Carts** -  comprehensive and advanced discounts system
  30 * **Payments** - over 30 payment provider integration out of the box plus API to integrate any other gateway
  31 * **Run everywhere** - cloud, VPS, Docker, Kubernetes
  32 * **Battle Tested** - used by thousands of merchants around the globe in all categories since 2007!
  33 * **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
  34 * **More features available via extensions** - dozens of extensions built by community, ready for use for free!
  35
  36 ![multi store](guides/src/images/features/international_978@2x.png)
  37
  38 ## Demo
  39
  40 See Spree in action: [demo.spreecommerce.org](https://demo.spreecommerce.org/)
  41
  42 Or fire up your own demo on Heroku:
  43
  44 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/spree/spree_starter)
  45
  46 Admin panel credentials for your own Heroku demo:
  47
  48 * login: `spree@example.com`
  49 * password: `spree123`
  50
  51 ## Installation
  52
  53 ### Option A - use Spree Starter with Docker
  54
  55 1. [Install Docker](https://docs.docker.com/get-docker/)
  56 2. Download [Spree Starter](https://github.com/spree/spree_starter/archive/main.zip)
  57 3. Unzip it
  58 4. Run `bin/setup` in `spree_starter-main` directory
  59
  60 ### Option B - add Spree to an existing Ruby on Rails application
  61
  62 1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/advanced/existing_app_tutorial.html)
  63
  64 ## Documentation
  65
  66 [Go to Spree Guides](https://guides.spreecommerce.org/)
  67
  68 ## Extensions
  69
  70 Extensions provide additional features and integrations for your Spree store
  71
  72 [Go to Extensions Directory](https://guides.spreecommerce.org/extensions/)
  73
  74 ## Contributing
  75
  76 Spree is an open source project and we love contributions in any form - pull requests, issues, feature ideas!
  77
  78 Please review the [Contributing Guide](https://guides.spreecommerce.org/developer/contributing/)
  79
  80 ## License
  81
  82 Spree is released under the [New BSD License](https://github.com/spree/spree/blob/master/license.md).
  83
  84 ## About Spark Solutions
  85
  86 [![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]
  87
  88 [Spark Solutions][spark] is a full stack eCommerce agency specialized in Spree Commerce, Ruby on Rails and JavaScript. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of Designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
  89
  90 We are passionate about open source software.
  91 We are [available for hire][spark].
  92
  93 [spark]:https://sparksolutions.co?utm_source=github