From 710e05ad8905705ec4f08c32cf5abd5ee3d8ae20 Mon Sep 17 00:00:00 2001 From: Sammy filly <136061549+sammyfilly@users.noreply.github.com> Date: Thu, 7 Sep 2023 18:13:56 +0100 Subject: [PATCH] Create e-commerce guide --- Nextjs/e-commerce guide | 111 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 Nextjs/e-commerce guide diff --git a/Nextjs/e-commerce guide b/Nextjs/e-commerce guide new file mode 100644 index 0000000..a3d65f0 --- /dev/null +++ b/Nextjs/e-commerce guide @@ -0,0 +1,111 @@ +job: read file before using +reason: to skip if available +Next.js Commerce + +The all-in-one starter kit for high-performance e-commerce sites. With a few clicks, Next.js developers can clone, deploy and fully customize their own store. Start right now at nextjs.org/commerce + +Demo live at: demo.vercel.store + +Shopify Demo: https://shopify.vercel.store/ +Swell Demo: https://swell.vercel.store/ +BigCommerce Demo: https://bigcommerce.vercel.store/ +Vendure Demo: https://vendure.vercel.store +Saleor Demo: https://saleor.vercel.store/ +Ordercloud Demo: https://ordercloud.vercel.store/ +Spree Demo: https://spree.vercel.store/ +Kibo Commerce Demo: https://kibocommerce.vercel.store/ +Commerce.js Demo: https://commercejs.vercel.store/ +SalesForce Cloud Commerce Demo: https://salesforce-cloud-commerce.vercel.store/ +Run minimal version locally + +To run a minimal version of Next.js Commerce you can start with the default local provider @vercel/commerce-local that has all features disabled (cart, auth) and uses static files for the backend +pnpm install & pnpm build # run these commands in the root folder of the mono repo +pnpm dev # run this command in the site folder +If you encounter any problems while installing and running for the first time, please see the Troubleshoot section +Features + +Performant by default +SEO Ready +Internationalization +Responsive +UI Components +Theming +Standardized Data Hooks +Integrations - Integrate seamlessly with the most common ecommerce platforms. +Dark Mode Support +Integrations + +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. + +Considerations + +packages/commerce contains all types, helpers and functions to be used as a base to build a new provider. +Providers live under packages's root folder and they will extend Next.js Commerce types and functionality (packages/commerce). +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. +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. +Configuration + +How to change providers + +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). + +The setup for Shopify would look like this for example: + +COMMERCE_PROVIDER=@vercel/commerce-shopify +NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxx +NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN=xxxxxxx.myshopify.com +Features + +Every provider defines the features that it supports under packages/{provider}/src/commerce.config.json + +Features Available + +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. + +cart +search +wishlist +customerAuth +customCheckout +How to turn Features on and off + +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) +Open site/commerce.config.json +You'll see a config file like this: +{ + "features": { + "wishlist": false, + "customCheckout": true + } +} +Turn wishlist on by setting wishlist to true. +Run the app and the wishlist functionality should be back on. +How to create a new provider + +Follow our docs for Adding a new Commerce Provider. + +If you succeeded building a provider, submit a PR with a valid demo and we'll review it asap. + +Contribute + +Our commitment to Open Source can be found here. + +Fork this repository to your own GitHub account and then clone it to your local device. +Create a new branch git checkout -b MY_BRANCH_NAME +Install the dependencies: pnpm install +Build the packages: pnpm build +Duplicate site/.env.template and rename it to site/.env.local +Add proper store values to site/.env.local +Run cd site & pnpm dev to watch for code changes +Run pnpm turbo run build to check the build after your changes +Work in progress + +We're using Github Projects to keep track of issues in progress and todo's. Here is our Board + +People actively working on this project: @okbel, @lfades, @dominiksipowicz, @gbibeaul. + +Troubleshoot + +I don't own a BigCommerce store. What should I do? +BigCommerce shows a Coming Soon page and requests a Preview Code +When run locally I get `Error: Cannot find module '...@vercel/commerce/dist/config'`>o