crowetic/commerce
1
0
Fork 1
mirror of https://github.com/vercel/commerce.git synced 2025-07-22 12:24:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Damian Legawiec
2021-09-13 12:30:19 +02:00
committed by GitHub
parent c0f1a66afe
commit 632c2c63a5
1 changed files with 13 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
framework/spree/README.md
View File

@@ -2,32 +2,26 @@
![Screenshots of Spree Commerce and NextJS Commerce][5]
A preview integration of Spree Commerce within NextJS Commerce. It supports browsing and searching Spree products and adding products to the cart as a guest user. [You can see it in action online.][6]
An integration of [Spree Commerce](https://spreecommerce.org/) within NextJS Commerce. It supports browsing and searching Spree products and adding products to the cart.
**Demo**: [https://spree-x-nextjscommerce-demo.vercel.app/][6]
## Installation
Start by following the [instructions for setting up NextJS Commerce][2].
1. Setup Spree [following Getting Started guide](https://dev-docs.spreecommerce.org/getting-started/installation)
Afterwards, configure NextJS Commerce to use the Spree Provider. Create a `.env.local` file in the root of the project. Its contents must be based on `framework/spree/.env.template`.
1. Setup Nextjs Commerce - [instructions for setting up NextJS Commerce][2].
`NEXT_PUBLIC_SPREE_CATEGORIES_TAXONOMY_PERMALINK` and `NEXT_PUBLIC_SPREE_BRANDS_TAXONOMY_PERMALINK` rely on taxonomies' permalinks in Spree. Go to the Spree admin panel and create Categories and Brands taxonomies if they don't exist and copy their permalinks into `.env.local` in NextJS Commerce. The values of the other environment variables can be copied from `framework/spree/.env.template` as is.
2. Copy the `.env.template` file in this directory to `.env.local` in the main directory
---
Setup Spree next. The easiest way to run Spree locally is to follow the installation tutorial available at [the Spree Starter GitHub repository][3].
You have to adjust Spree Starter to allow local [CORS][4] requests and have Spree run on port `4000` instead of the default port (NextJS Commerce and Spree both use port `3000` by default). To do this, add two environment variables inside `.env` in the Spree Starter project:
```shell
DOCKER_HOST_WEB_PORT=4000
ALLOWED_ORIGIN_HOSTS=*
```bash
cp framework/spree/.env.template .env.local
```
Also, add the following line inside `config/environments/development.rb` to allow HTTP requests to Spree from NextJS:
3. Set `NEXT_PUBLIC_SPREE_CATEGORIES_TAXONOMY_PERMALINK` and `NEXT_PUBLIC_SPREE_BRANDS_TAXONOMY_PERMALINK` Env variables
```
config.hosts << 'localhost'
```
* They rely on [taxonomies'](https://dev-docs.spreecommerce.org/internals/products#taxons-and-taxonomies) permalinks in Spree.
* Go to the Spree admin panel and create `Categories` and `Brands` taxonomies if they don't exist and copy their permalinks into `.env.local` in NextJS Commerce.
---