From 9dbd3741c947df05d880aba1f64f97d4b2580032 Mon Sep 17 00:00:00 2001 From: DuvCharles Date: Tue, 5 Dec 2023 17:39:15 +0100 Subject: [PATCH] :memo: read me --- .env.example | 6 ++- README.md | 54 ++++++--------------- lib/sylius/index.ts | 2 +- lib/sylius/normalizer/product-normalizer.ts | 2 +- 4 files changed, 21 insertions(+), 43 deletions(-) diff --git a/.env.example b/.env.example index c5171847f5..3c45c850d3 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,6 @@ TWITTER_CREATOR="@DuvCharles" -TWITTER_SITE="https://nextjs.org/commerce" +TWITTER_SITE="https://twitter.com/DuvCharles" SITE_NAME="Next.js Commerce" -SYLIUS_STORE_DOMAIN=localhost:8001 +NEXT_PUBLIC_SYLIUS_BACKEND_API=http://yourDomain +NEXT_PUBLIC_SYLIUS_API_URL=http://yourDomain +NEXT_PUBLIC_SYLIUS_ALLOWED_IMAGE_DOMAIN=http://yourDomain \ No newline at end of file diff --git a/README.md b/README.md index 5816f61e62..941f8b71fb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -[![Deploy with Vercel](https://vercel.com/button)](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) +# Next.js Commerce x Sylius -# Next.js Commerce - -A Next.js 13 and App Router-ready ecommerce template featuring: +A Next.js 14 and App Router-ready ecommerce template, built with [Sylius](https://github.com/sylius/sylius), featuring: - Next.js App Router - Optimized for SEO using Next.js's Metadata @@ -12,39 +10,31 @@ A Next.js 13 and App Router-ready ecommerce template featuring: - New fetching and caching paradigms - Dynamic OG images - Styling with Tailwind CSS -- Checkout and payments with Shopify - Automatic light/dark mode based on system settings -

+## What is Sylius? -> 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). +[Sylius](https://sylius.com/) is an open-source e-commerce platform written in PHP. It is built on top of the Symfony framework and offers a wide range of features for building and managing an online store, including product management, order management, and checkout. -## Providers +## Requirements -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). +- Node.js +- PHP -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. +## Getting started -- Shopify (this repository) -- [BigCommerce](https://github.com/bigcommerce/nextjs-commerce) ([Demo](https://next-commerce-v2.vercel.app/)) -- [Medusa](https://github.com/medusajs/vercel-commerce) ([Demo](https://medusa-nextjs-commerce.vercel.app/)) -- [Saleor](https://github.com/saleor/nextjs-commerce) ([Demo](https://saleor-commerce.vercel.app/)) -- [Shopware](https://github.com/shopwareLabs/vercel-commerce) ([Demo](https://shopware-vercel-commerce-react.vercel.app/)) -- [Swell](https://github.com/swellstores/verswell-commerce) ([Demo](https://verswell-commerce.vercel.app/)) -- [Umbraco](https://github.com/umbraco/Umbraco.VercelCommerce.Demo) ([Demo](https://vercel-commerce-demo.umbraco.com/)) -- [Wix](https://github.com/wix/nextjs-commerce) ([Demo](https://wix-nextjs-commerce.vercel.app/)) +### Running Sylius -> 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). +1. You need a [Sylius](https://sylius.com/download/) instance, either in the cloud or self-hosted. +2. Follow the Read-Me of this [repository](https://github.com/theodo/sylius-commerce-config) to configure your Sylius Project -## Running locally +### Running Next.js Commerce -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. +1\. You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js Commerce. Copy the contents of .env.example to a .env file in the root of your Next.js Commerce project, and make sure the NEXT_PUBLIC_Sylius_BACKEND_API environment variable points to your Sylius backend domain (default: http://localhost:8000). -> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control your Shopify store. +> Note: You should not commit your `.env` file or it will expose secrets. -1. Install Vercel CLI: `npm i -g vercel` -2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link` -3. Download your environment variables: `vercel env pull` +2\. From the `nextjs-commerce` subfolder, run: ```bash pnpm install @@ -52,17 +42,3 @@ pnpm dev ``` Your app should now be running on [localhost:3000](http://localhost:3000/). - -
- Expand if you work at Vercel and want to run locally and / or contribute - -1. Run `vc link`. -1. Select the `Vercel Solutions` scope. -1. Connect to the existing `commerce-shopify` project. -1. Run `vc env pull` to get environment variables. -1. Run `pmpm dev` to ensure everything is working correctly. -
- -## Vercel, Next.js Commerce, and Shopify Integration Guide - -You can use this comprehensive [integration guide](http://vercel.com/docs/integrations/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. diff --git a/lib/sylius/index.ts b/lib/sylius/index.ts index 270c1027cf..509b343d1d 100644 --- a/lib/sylius/index.ts +++ b/lib/sylius/index.ts @@ -12,7 +12,7 @@ import { UpdateCartPayload } from './types'; -const DOMAIN = `${process.env.SYLIUS_STORE_DOMAIN}`; +const DOMAIN = `${process.env.NEXT_PUBLIC_SYLIUS_BACKEND_API}`; const ENDPOINT = `${DOMAIN}${SYLIUS_API_ENDPOINT}`; // Fetch diff --git a/lib/sylius/normalizer/product-normalizer.ts b/lib/sylius/normalizer/product-normalizer.ts index 542f409403..524fcb21af 100644 --- a/lib/sylius/normalizer/product-normalizer.ts +++ b/lib/sylius/normalizer/product-normalizer.ts @@ -48,7 +48,7 @@ const normalizeProductOption = (option: SyliusProductOption): ProductOption => ( }); export const normalizeProductImage = (image: SyliusProductImage): Image => ({ - url: process.env.NEXT_PUBLIC_SYLIUS_API_URL + image.path, + url: process.env.NEXT_PUBLIC_SYLIUS_BACKEND_API + image.path, altText: image.path, width: 400, height: 400