Skip to content

Commit 906b12b

Browse files
authored
Update README.md
1 parent 8cb73aa commit 906b12b

File tree

1 file changed

+0
-75
lines changed

1 file changed

+0
-75
lines changed

README.md

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -104,78 +104,3 @@ Standardized Data Hooks
104104
Integrations - Integrate seamlessly with the most common ecommerce platforms.
105105
Dark Mode Support
106106
Integrations
107-
108-
Next.js Commerce integrates out-of-the-box with BigCommerce, Shopify, Swell, Saleor, Vendure, Spree and Commerce.js. We plan to support all major ecommerce backends.
109-
110-
Considerations
111-
112-
packages/commerce contains all types, helpers and functions to be used as a base to build a new provider.
113-
Providers live under packages's root folder and they will extend Next.js Commerce types and functionality (packages/commerce).
114-
We have a Features API to ensure feature parity between the UI and the Provider. The UI should update accordingly and no extra code should be bundled. All extra configuration for features will live under features in commerce.config.json and if needed it can also be accessed programmatically.
115-
Each provider should add its corresponding next.config.js and commerce.config.json adding specific data related to the provider. For example in the case of BigCommerce, the images CDN and additional API routes.
116-
Configuration
117-
118-
How to change providers
119-
120-
Open site/.env.local and change the value of COMMERCE_PROVIDER to the provider you would like to use, then set the environment variables for that provider (use site/.env.template as the base).
121-
122-
The setup for Shopify would look like this for example:
123-
124-
COMMERCE_PROVIDER=@vercel/commerce-shopify
125-
NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
126-
NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN=xxxxxxx.myshopify.com
127-
Features
128-
129-
Every provider defines the features that it supports under packages/{provider}/src/commerce.config.json
130-
131-
Features Available
132-
133-
The following features can be enabled or disabled. This means that the UI will remove all code related to the feature. For example: turning cart off will disable Cart capabilities.
134-
135-
cart
136-
search
137-
wishlist
138-
customerAuth
139-
customCheckout
140-
How to turn Features on and off
141-
142-
NOTE: The selected provider should support the feature that you are toggling. (This means that you can't turn wishlist on if the provider doesn't support this functionality out of the box)
143-
Open site/commerce.config.json
144-
You'll see a config file like this:
145-
{
146-
"features": {
147-
"wishlist": false,
148-
"customCheckout": true
149-
}
150-
}
151-
Turn wishlist on by setting wishlist to true.
152-
Run the app and the wishlist functionality should be back on.
153-
How to create a new provider
154-
155-
Follow our docs for Adding a new Commerce Provider.
156-
157-
If you succeeded building a provider, submit a PR with a valid demo and we'll review it asap.
158-
159-
Contribute
160-
161-
Our commitment to Open Source can be found here.
162-
163-
Fork this repository to your own GitHub account and then clone it to your local device.
164-
Create a new branch git checkout -b MY_BRANCH_NAME
165-
Install the dependencies: pnpm install
166-
Build the packages: pnpm build
167-
Duplicate site/.env.template and rename it to site/.env.local
168-
Add proper store values to site/.env.local
169-
Run cd site & pnpm dev to watch for code changes
170-
Run pnpm turbo run build to check the build after your changes
171-
Work in progress
172-
173-
We're using Github Projects to keep track of issues in progress and todo's. Here is our Board
174-
175-
People actively working on this project: @okbel, @lfades, @dominiksipowicz, @gbibeaul.
176-
177-
Troubleshoot
178-
179-
I don't own a BigCommerce store. What should I do?
180-
BigCommerce shows a Coming Soon page and requests a Preview Code
181-
When run locally I get `Error: Cannot find module '...@vercel/commerce/dist/config'`>

0 commit comments

Comments
 (0)