diff --git a/framework/spree/README.md b/framework/spree/README.md index 1fc5a46fe..d83b61dcd 100644 --- a/framework/spree/README.md +++ b/framework/spree/README.md @@ -1,4 +1,4 @@ -# [Spree Commerce][1] Provider +# [Spree Commerce][1] Framework 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. @@ -8,7 +8,7 @@ Start by following the [instructions for setting up NextJS Commerce][2]. Next, setup Spree. The easiest way to run Spree locally is to follow the installation tutorial available at [the Spree Starter GitHub repository][3]. -You may have to adjust Spree Starter to allow `localhost` and [CORS][4] requests. Run `docker-compose run web bundle add rack-cors` and: +You have to adjust Spree Starter to allow `localhost` and [CORS][4] requests. Run `docker-compose run web bundle add rack-cors` and: ```ruby # In config/application.rb add a configuration for CORS: @@ -43,6 +43,12 @@ By default, Spree Starter and NextJS Commerce both run on port `3000`. Avoid col } ``` +Third, supply NextJS Commerce with custom environment variables required by the Spree Framework. Create a `.env.local` file in the root of NJC with contents based on `framework/spree/.env.template`. + +`NEXT_PUBLIC_SPREE_CATEGORIES_TAXONOMY_ID` and `NEXT_PUBLIC_SPREE_BRANDS_TAXONOMY_ID` rely on IDs generated by Spree. Go to the Spree admin panel and create Categories and Brands taxonomies if they don't exist and copy their IDs into `.env.local`. The values of the other environment variables can be copied from `framework/spree/.env.template` as is. + +Lastly, run `yarn dev` :tada: + [1]: https://spreecommerce.org/ [2]: https://github.com/vercel/commerce [3]: https://github.com/spree/spree_starter