|
| 1 | +[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&env=COMPANY_NAME,SHOPIFY_REVALIDATION_SECRET,SHOPIFY_STORE_DOMAIN,SHOPIFY_STOREFRONT_ACCESS_TOKEN,SITE_NAME,TWITTER_CREATOR,TWITTER_SITE) |
| 2 | + |
| 3 | +# Next.js Commerce |
| 4 | + |
| 5 | +A high-perfomance, server-rendered Next.js App Router ecommerce application. |
| 6 | + |
| 7 | +This template uses React Server Components, Server Actions, `Suspense`, `useOptimistic`, and more. |
| 8 | + |
| 9 | +<h3 id="v1-note"></h3> |
| 10 | + |
| 11 | +> Note: Looking for Next.js Commerce v1? View the [code](https://github.com/vercel/commerce/tree/v1), [demo](https://commerce-v1.vercel.store), and [release notes](https://github.com/vercel/commerce/releases/tag/v1). |
| 12 | +
|
| 13 | +## Providers |
| 14 | + |
| 15 | +Vercel will only be actively maintaining a Shopify version [as outlined in our vision and strategy for Next.js Commerce](https://github.com/vercel/commerce/pull/966). |
| 16 | + |
| 17 | +Vercel is happy to partner and work with any commerce provider to help them get a similar template up and running and listed below. Alternative providers should be able to fork this repository and swap out the `lib/shopify` file with their own implementation while leaving the rest of the template mostly unchanged. |
| 18 | + |
| 19 | +- Shopify (this repository) |
| 20 | +- [BigCommerce](https://github.com/bigcommerce/nextjs-commerce) ([Demo](https://next-commerce-v2.vercel.app/)) |
| 21 | +- [Ecwid by Lightspeed](https://github.com/Ecwid/ecwid-nextjs-commerce/) ([Demo](https://ecwid-nextjs-commerce.vercel.app/)) |
| 22 | +- [Medusa](https://github.com/medusajs/vercel-commerce) ([Demo](https://medusa-nextjs-commerce.vercel.app/)) |
| 23 | +- [Saleor](https://github.com/saleor/nextjs-commerce) ([Demo](https://saleor-commerce.vercel.app/)) |
| 24 | +- [Shopware](https://github.com/shopwareLabs/vercel-commerce) ([Demo](https://shopware-vercel-commerce-react.vercel.app/)) |
| 25 | +- [Swell](https://github.com/swellstores/verswell-commerce) ([Demo](https://verswell-commerce.vercel.app/)) |
| 26 | +- [Umbraco](https://github.com/umbraco/Umbraco.VercelCommerce.Demo) ([Demo](https://vercel-commerce-demo.umbraco.com/)) |
| 27 | +- [Wix](https://github.com/wix/nextjs-commerce) ([Demo](https://wix-nextjs-commerce.vercel.app/)) |
| 28 | + |
| 29 | +> Note: Providers, if you are looking to use similar products for your demo, you can [download these assets](https://drive.google.com/file/d/1q_bKerjrwZgHwCw0ovfUMW6He9VtepO_/view?usp=sharing). |
| 30 | +
|
| 31 | +## Integrations |
| 32 | + |
| 33 | +Integrations enable upgraded or additional functionality for Next.js Commerce |
| 34 | + |
| 35 | +- [Orama](https://github.com/oramasearch/nextjs-commerce) ([Demo](https://vercel-commerce.oramasearch.com/)) |
| 36 | + - Upgrades search to include typeahead with dynamic re-rendering, vector-based similarity search, and JS-based configuration. |
| 37 | + - Search runs entirely in the browser for smaller catalogs or on a CDN for larger. |
| 38 | + |
| 39 | +- [React Bricks](https://github.com/ReactBricks/nextjs-commerce-rb) ([Demo](https://nextjs-commerce.reactbricks.com/)) |
| 40 | + - Edit pages, product details, and footer content visually using [React Bricks](https://www.reactbricks.com) visual headless CMS. |
| 41 | + |
| 42 | +## Running locally |
| 43 | + |
| 44 | +You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js Commerce. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables) for this, but a `.env` file is all that is necessary. |
| 45 | + |
| 46 | +> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control your Shopify store. |
| 47 | +
|
| 48 | +1. Install Vercel CLI: `npm i -g vercel` |
| 49 | +2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link` |
| 50 | +3. Download your environment variables: `vercel env pull` |
| 51 | + |
| 52 | +```bash |
| 53 | +pnpm install |
| 54 | +pnpm dev |
| 55 | +``` |
| 56 | + |
| 57 | +Your app should now be running on [localhost:3000](http://localhost:3000/). |
| 58 | + |
| 59 | +<details> |
| 60 | + <summary>Expand if you work at Vercel and want to run locally and / or contribute</summary> |
| 61 | + |
| 62 | +1. Run `vc link`. |
| 63 | +1. Select the `Vercel Solutions` scope. |
| 64 | +1. Connect to the existing `commerce-shopify` project. |
| 65 | +1. Run `vc env pull` to get environment variables. |
| 66 | +1. Run `pnpm dev` to ensure everything is working correctly. |
| 67 | +</details> |
| 68 | + |
| 69 | +## Vercel, Next.js Commerce, and Shopify Integration Guide |
| 70 | + |
| 71 | +You can use this comprehensive [integration guide](https://vercel.com/docs/integrations/ecommerce/shopify) with step-by-step instructions on how to configure Shopify as a headless CMS using Next.js Commerce as your headless Shopify storefront on Vercel. |
0 commit comments