Skip to content

Commit ff20dfc

Browse files
committed
feat: add more setup instructions to the readme
1 parent 6cb427e commit ff20dfc

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

examples/spa-elastic-path-payments/README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,64 @@ Before running this example, you'll need:
2222

2323
1. **Elastic Path Commerce Cloud Store** with Elastic Path Payments enabled
2424
2. **Stripe Account** - Elastic Path Payments is powered by Stripe
25-
3. **Stripe Publishable Key** - Get this from your Stripe Dashboard
25+
3. **Stripe Publishable Key** and **Account ID** - Get these from your Stripe Dashboard
26+
27+
---
28+
29+
## Store Setup Requirements
30+
31+
To use this example, your **Elastic Path Commerce Cloud store** must be properly configured:
32+
33+
### 🔌 **Payment Gateway Configuration**
34+
35+
1. **Enable Elastic Path Payments** in Commerce Manager:
36+
37+
- Go to **Settings****Payment Gateways**
38+
- Configure **Elastic Path Payments** gateway
39+
- Add your **Stripe Connect account**
40+
- Enable the gateway and test mode
41+
42+
### 📦 **Product Setup**
43+
44+
Your store needs products in a published catalog for the payment demo to work. Learn more about how to publish a catalog [in the docs](https://elasticpath.dev/docs/commerce-manager/product-experience-manager/catalogs/catalog-configuration):
45+
46+
1. **Product Requirements**:
47+
48+
- Add at least one **simple product** (not a base product requiring variations)
49+
- Products should have **prices** associated with them
50+
- Products must be **active** and included in the published catalog
51+
52+
2. **Inventory Configuration** (Optional):
53+
- If using inventory management, ensure products have **stock levels** configured
54+
55+
### 🔑 **API Access Setup**
56+
57+
1. **Client Credentials**:
58+
59+
- Go to **Settings****API Keys** and create a new application key
60+
- Note your **Client ID** and **Store URL** and use them in your .env
61+
62+
2. **Stripe Keys**:
63+
- From your **connected Stripe account**, obtain:
64+
- **Publishable Key** (`pk_test_...` for test mode or `pk_live_...` for live)
65+
- **Account ID** (`acct_...`) - This identifies your specific Stripe Connect account
66+
67+
### 🚨 **Common Setup Issues**
68+
69+
**"No such payment_intent" Error**:
70+
71+
- **Cause**: Frontend Stripe keys don't match the backend Stripe account
72+
- **Solution**: Ensure `VITE_STRIPE_PUBLISHABLE_KEY` and `VITE_STRIPE_ACCOUNT_ID` are from the same Stripe account connected to Elastic Path
73+
74+
**"No products available" Error**:
75+
76+
- **Cause**: No products in published catalog, catalog not published, or all products are base products
77+
- **Solution**: Create and publish a catalog with at least one simple product
78+
79+
**404 Inventory Errors**:
80+
81+
- **Cause**: Product inventory not configured
82+
- **Solution**: Either configure inventory or ignore (example handles gracefully)
2683

2784
---
2885

0 commit comments

Comments
 (0)