Use `tinymce-rails` asset version of tinymce (#12343)
[spree.git] / README.md
blob8aefaf04122f7d0bc6cf6f14bca7cd01c2ed2ec5
1 <p align="center">
2   <a href="https://spreecommerce.org">
3     <img alt="Spree Commerce - an open source eCommerce platform" src="https://github.com/spree/spree/assets/12614496/ff5372a4-e906-458e-83b6-7927ba0629c1">
4   </a>
6   <h1 align="center">Spree Commerce</h2>
8   <p align="center">
9     An <a href="https://spreecommerce.org/" alt="open-source eCommerce platform">open-source eCommerce platform</a> giving you full control and customizability.
10     <br />
11     Build any eCommerce solution that your business requires.
12     <br />
13     <br />
14     <a href="https://slack.spreecommerce.org">Slack</a>
15     ·
16     <a href="https://spreecommerce.org/docs/">Documentation</a>
17     ·
18     <a href="https://spreecommerce.org">Website</a>
19     ·
20     <a href="https://demo.spreecommerce.org">Demo</a>
21     ·
22     <a href="https://github.com/spree/spree/milestones?direction=asc&sort=due_date&state=open">Roadmap</a>
23   </p>
24 </p>
26 <p align="center">
27   <a href="https://rubygems.org/gems/spree">
28     <img alt="Gem Total Downloads" src="https://img.shields.io/gem/dt/spree" />
29   </a>
30   <a href="https://slack.spreecommerce.org">
31     <img alt="Slack members" src="https://img.shields.io/badge/slack%20members-6.5K-blue" />
32   </a>
33 </p>
35 ## Getting Started
37 Visit the [Quickstart Guide](https://spreecommerce.org/docs/developer/getting-started/quickstart) to set up Spree in 5 minutes.
39 If you like what you see, consider giving Spree a GitHub star :star:
41 Thank you for supporting Spree open-source :heart:
43 ## Enterprise support
45 [Contact us](https://spreecommerce.org/contact/) for enterprise support and custom development services. We offer:
46   * migrations and upgrades,
47   * delivering your Spree application,
48   * optimizing your Spree stack.
50 ## Enterprise Edition - [Vendo](https://getvendo.com)
52 Besides Enterprise support we also offer an enterprise Spree version called [Vendo](https://getvendo.com) - which is a commercial offering from the Spree team that gives you all the tools you need to launch your store or marketplace and provides you with ready-to-use integrations that will reduce your project's development time and cost.
54 To get access to Spree Enterprise (Vendo), contact our [Sales team](https://spreecommerce.org/get-started/)
56 ## Features
57 ### Customizable and modular
58   * pick and choose parts you want to use
59   * customize everything else (storefront, order processing, API, etc)
60 <img alt="Spree Commerce - Storefront customization" src="https://github.com/spree/spree/assets/12614496/1a000452-6716-4fab-90ca-a4c28fc138a7">
62 ### Composable and API-first
63   * connect with your existing ecosystem, build custom workflows with ease
64   * [Storefront and Admin API](https://spreecommerce.org/docs/api-reference/introduction)
65   * Webhooks
66 <img alt="Spree Commerce - API   Integrations" src="https://github.com/spree/spree/assets/12614496/18e98e8e-15cd-4b74-8e58-80e5b3f281d8">
68 ### Cart and Checkout for any use case
69   * advanced cart functionality
70   * over 30 payment provider integrations out of the box
71   * API to integrate any other payment gateway
72   * robust discounts system
73   * store credits, gift cards
74 <img alt="Spree Commerce - Cart   Checkout" src="https://github.com/spree/spree/assets/12614496/05399a8f-a57a-4907-a8ea-a4e58285a55d">
75 <img alt="Spree Commerce - Payments   Refunds" src="https://github.com/spree/spree/assets/12614496/0911073c-a681-409e-810c-f7e8daa4daac">
77 ### [Global Commerce](https://spreecommerce.org/multi-region-ecommerce/) ready
78   * multi-currency
79   * multi-language
80   * full translation support for products, categories, and more
81   * different shipping methods / costs for different regions
82   * advanced tax calculation
83 <img alt="Spree Commerce - Multi-region   Multi-store" src="https://github.com/spree/spree/assets/12614496/e9c2edce-b80c-47ad-817b-a00a4ba54495">
84 <img alt="Spree Commerce - Multi-region" src="https://github.com/spree/spree/assets/12614496/f8678baf-4efa-4de7-b092-b01ef3a4d8ea">
86 ### [Multi-Store](https://spreecommerce.org/multi-store-ecommerce/) ready
87   * host multiple brands / stores on a single Spree instance
88   * each with different branding, configuration, payment methods, shipping options, product catalogs etc
89 <img alt="Spree Commerce - Multi-store" src="https://github.com/spree/spree/assets/12614496/cf651354-6180-4927-973f-c650b80ccdb0">
91 ### Responsive Admin Panel
92 Manage and curate products, users, orders, returns, shipments & more
93 <img alt="Spree Commerce - Inventory management" src="https://github.com/spree/spree/assets/12614496/cdc7af4d-41ba-44f2-9595-efc948865107">
95 ### Orders & Post-purchase management
96 Manage orders, shipments, returns and refunds
97 <img alt="Spree Commerce - Order   Return management" src="https://github.com/spree/spree/assets/12614496/b1dffa8c-24d4-4629-a026-02951b5a80d7">
98 <img alt="Spree Commerce - Order Fulfillment" src="https://github.com/spree/spree/assets/12614496/2212ec6d-bfd0-4940-9aae-f0ceea0b4e4d">
100 ### Why developers love it
101 * **Runs anywhere** - cloud, VPS, Docker, Kubernetes
102 * **Battle Tested** - used by thousands of merchants around the globe in all categories since 2007!
103 * **Extensions available** adding new features to Spree
105 ## What you can build with Spree
106 Use Spree for any use case. Innovate beyond what's out there.
108 ### A [headless eCommerce](https://spreecommerce.org/headless-ecommerce/) micro-service
109 Capture orders and payments for whatever you're selling - physical or digital, products or services
111 <img alt="Spree Commerce - headless open-source eCommerce" src="https://github.com/spree/spree/assets/12614496/2bca9fdf-5ae2-4433-83aa-431105906fc8">
113 ### A [Multi-vendor marketplace](https://spreecommerce.org/use-cases/multi-vendor-marketplace-demo/)
114 Run your own marketplace with multiple suppliers, each with a dedicated supplier dashboard
115 <img alt="Spree Commerce - Marketplace" src="https://github.com/spree/spree/assets/12614496/c4ddd118-df4c-464e-b1fe-d43862e5cf25">
117 ### A [B2B eCommerce](https://spreecommerce.org/use-cases/headless-b2b-ecommerce/)
118 Start capturing 6+ figure orders from resellers with safe payments and a checkout process that fits your business model
119 <img alt="Spree Commerce - B2B eCommerce" src="https://github.com/spree/spree/assets/12614496/e0a184f6-31ad-4f7f-b30b-6f8a501b6f63">
121 ### [Wholesale eCommerce](https://spreecommerce.org/use-cases/wholesale-ecommerce/)
122 Run your wholesale operation the way your retail partners expect
123 <img alt="Spree Commerce - Wholesale" src="https://github.com/spree/spree/assets/12614496/bac1e551-f629-47d6-a983-b385aa65b1bd">
125 ### A [white-label SaaS or multi-tenant eCommerce](https://spreecommerce.org/multi-tenant-white-label-ecommerce/) platform
126 Launch a [multi-tenant eCommerce platform](https://spreecommerce.org/multi-tenant-white-label-ecommerce/) for your customers, resellers, affiliates in any configuration, eg. B2B2B, B2B2C, B2B2E
128 <img alt="Spree Commerce - Multi-store" src="https://github.com/spree/spree/assets/12614496/cf651354-6180-4927-973f-c650b80ccdb0">
130 ## Community & Contributing
132 Spree is an open source project and we love contributions in any form - pull requests, issues, feature ideas!
134 Follow our [Contributing Guide](https://spreecommerce.org/docs/developer/contributing/quickstart)
136 [Join our Slack](https://slack.spreecommerce.org) to meet other community members.
138 ## Contact
140 [Contact us](https://spreecommerce.org/contact/) and let's go! 
142 ## Developed by
144 Spree is developed and maintained by
146 <a href="https://getvendo.com">
147 <img alt="Vendo" src="https://cdn.getvendo.com/assets/vendo-logo-4bda02af8c99bc2ecc5a400120f0ebe4eafcd385e02e25f198a8c355ab75d1ff.png" />
148 </a>
150 > Vendo is an eCommerce platform based on Spree which you can customize to your exact needs (source available).
151 Go global on day 1. DTC x B2B x Marketplace. API-first. One or multiple storefronts.
153 ## License
155 Spree Commerce is a free, open-source eCommerce framework giving you full control and customizability.
157 For Spree Commerce versions 4.10 and later in the [spree/spree](https://github.com/spree/spree) repository two licenses apply simultaneously and users are required to comply with the terms of these two licenses at the same time:
159 * [AGPL-3.0](https://opensource.org/license/agpl-v3) - for all contributions from version 4.10 onwards
161 * [BSD-3-Clause](https://opensource.org/license/bsd-3-clause) - for all other contributions predating version 4.10
163 Effectively, for versions 4.10 and upwards **AGPL-3.0** license applies.
165 Spree Commerce versions 4.9 and earlier in the [spree/spree](https://github.com/spree/spree) repository are available under the BSD-3-Clause license and users are required to comply with its terms.
167 If you’d like to use Spree Commerce without the AGPL-3.0 restrictions e.g. for a SaaS business, please talk to us about obtaining a [Commercial License](LICENSE.md#commercial-license).
169 All third party components incorporated into this software are licensed under the original license provided by the owner of the applicable component.
171 Please refer to our [Licensing FAQ](https://spreecommerce.org/why-spree-is-changing-its-open-source-license-to-agpl-3-0-and-introducing-a-commercial-license/) in case of questions