Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Added multi-vendor installation docs

Damian Legawiec4cb8da4f4a19
diff --git a/docs/developer/multi-tenant/installation.mdx b/docs/developer/multi-tenant/installation.mdx
index 835568225c..b35d6a5dce 100644
--- a/docs/developer/multi-tenant/installation.mdx
+++ b/docs/developer/multi-tenant/installation.mdx
@@ -12,15 +12,20 @@ description: Learn how to setup a multi-tenant eCommerce (SaaS) with Spree
## Prerequisites
-* You need to be on Spree 5.1+
+* You need to be on Spree 5.1+, we recommend using [spree_starter](https://github.com/spree/spree_starter) as a base for your application
* You need to have 2 environment variables set:
* `KEYGEN_ACCOUNT_ID`
* `KEYGEN_LICENSE_KEY`
+* We support both PostgreSQL and MySQL databases
<Info>
Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
</Info>
+<Warning>
+ You will need to add these environment variables to your CI/CD pipeline and production environments.
+</Warning>
+
## Customer User Class
Please follow [Authentication](/docs/developer/customization/authentication) documentation to create a new user class.
@@ -53,14 +58,6 @@ class Spree::AdminUser < Spree::Base
# Spree modules
include Spree::UserMethods
-
- def login=(login)
- @email = login
- end
-
- def login
- @email
- end
end
```
@@ -69,14 +66,6 @@ If you already have a custom Admin user class, you can add the following code to
```ruby
# Spree modules
include Spree::UserMethods
-
- def login=(login)
- @email = login
- end
-
- def login
- @email
- end
```
This will make sure that the Admin user class works well with Spree ecosystem.
diff --git a/docs/developer/multi-vendor/installation.mdx b/docs/developer/multi-vendor/installation.mdx
new file mode 100644
index 0000000000..0f5721bbd2
--- /dev/null
+++ b/docs/developer/multi-vendor/installation.mdx
@@ -0,0 +1,53 @@
+---
+title: Spree Multi Vendor Installation
+sidebarTitle: Installation
+description: Learn how to setup a multi-vendor marketplace with Spree
+---
+
+<Warning>
+ This installation instructions assume you have purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
+</Warning>
+
+## Prerequisites
+
+* You need to be on Spree 5.1+, we recommend using [spree_starter](https://github.com/spree/spree_starter) as a base for your application
+* You need to have 2 environment variables set:
+ * `KEYGEN_ACCOUNT_ID`
+ * `KEYGEN_LICENSE_KEY`
+* We support both PostgreSQL and MySQL databases
+* Redis for background jobs
+
+<Info>
+ Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
+</Info>
+
+<Warning>
+ You will need to add these environment variables to your CI/CD pipeline and production environments.
+</Warning>
+
+## Installing gems
+
+1. Add the following code to your `Gemfile`:
+
+ ```ruby
+ source "https://license:#{ENV['KEYGEN_LICENSE_KEY']}@rubygems.pkg.keygen.sh/#{ENV['KEYGEN_ACCOUNT_ID']}" do
+ gem 'spree_enterprise'
+ gem 'spree_multi_vendor'
+ end
+ ```
+
+2. Install gems:
+
+ ```bash
+ bundle install
+ ```
+
+3. Run generator:
+
+ ```bash
+ bundle exec rails spree_multi_vendor:install
+ ```
+
+ <Info>
+ This will copy and run migrations for `spree_multi_vendor` gem.
+ </Info>
diff --git a/docs/developer/multi-vendor/quickstart.mdx b/docs/developer/multi-vendor/quickstart.mdx
new file mode 100644
index 0000000000..8aa18aa75b
--- /dev/null
+++ b/docs/developer/multi-vendor/quickstart.mdx
@@ -0,0 +1,17 @@
+---
+title: Building a Multi-Vendor Marketplace with Spree
+sidebarTitle: Quickstart
+---
+
+If you want to have a true multi-vendor marketplace, you will need to purchase [Enterprise Edition license](https://spreecommerce.org/pricing) which includes `spree_multi_vendor` gem providing full multi-vendor support.
+
+## What is included in `spree_multi_vendor`
+
+1. **Ability to invite and manage vendors**, their products and orders
+2. Full fledged **vendor dashboard** where vendors can self-serve orders, products, manage their team, etc.
+3. White-label **Shopify Sales Channel application** allowing vendors to connect their Shopify stores, import products, shipping rates and receive orders to fulfill them like a regular order in their Shopify store.
+4. White-label **WooCommerce application** allowing vendors to connect their WooCommerce stores, import products, shipping rates and receive orders to fulfill them like a regular order in their WooCommerce store
+5. **Stripe Connect** integration allowing vendors to receive payments directly to their Stripe accounts, split payments between marketplace and vendors, automated payouts and more
+6. **Multi-party checkout** allowing customers to checkout with multiple vendors, split payments between them and receive separate invoices for each vendor
+7. **Flexible permission system** to tailor the marketplace to your needs (eg. disable/enable vendor panel features)
+8. **Vendor API** endpoints to allow vendors to manage their products, orders, etc.
\ No newline at end of file
diff --git a/docs/docs.json b/docs/docs.json
index b32f69c98b..9870ed6609 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -97,6 +97,14 @@
"developer/multi-tenant/core-concepts",
"developer/multi-tenant/configuration"
]
+ },
+ {
+ "group": "Multi-Vendor",
+ "icon": "shop",
+ "pages": [
+ "developer/multi-vendor/quickstart",
+ "developer/multi-vendor/installation"
+ ]
}
]
},