Skip to content

Commit be09c9d

Browse files
authored
Merge pull request #161 from medusajs/VariableVic-patch-2
Update README.md - add product module
2 parents df2a11c + de4249d commit be09c9d

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The Medusa Next.js Starter is built with:
4444
- [Medusa](https://medusajs.com/)
4545

4646
Features include:
47-
- Full e-commerce support:
47+
- Full ecommerce support:
4848
- Product Detail Page
4949
- Product Overview Page
5050
- Search with Algolia
@@ -55,7 +55,7 @@ Features include:
5555
- Order Details
5656
- Next.js 13
5757
- Full App Router support with [Dynamic Routes](https://nextjs.org/docs/app/building-your-application/routing/dynamic-routes) and [Route Groups](https://nextjs.org/docs/app/building-your-application/routing/route-groups)
58-
- [Product Module](https://docs.medusajs.com/modules/products/serverless-module) support (coming soon)
58+
- [Product Module](https://docs.medusajs.com/modules/products/serverless-module) support
5959

6060
# Quickstart
6161

@@ -98,6 +98,20 @@ Your site is now running at http://localhost:8000!
9898

9999
Edit `/pages/index.tsx` to see your site update in real-time!
100100

101+
# Product Module
102+
103+
This starter has full support for our new serverless [Product Module](https://docs.medusajs.com/modules/products/serverless-module) for retrieving and manipulating product data directly from a serverless function. This keeps your product logic close to the frontend, making it easy to customize or extend Medusa's core functionality from within your Next.js project.
104+
105+
By default, this starter uses the standard Medusa API for product and collection retrieval. To enable the Product Module, follow these steps:
106+
107+
1. Make sure the `PRODUCT_POSTGRES_URL` and `NEXT_PUBLIC_BASE_URL` environment variables are set properly.
108+
2. In `store.config.json`, set the `productModule` feature flag to `true` and save the file.
109+
3. Restart the dev server.
110+
111+
Done! All product and collection data should now be coming from the module. The Product Module routes are all in `src/app/api` for you to edit and play around with.
112+
113+
To opt out of using the module, simply set the feature flag to `false` and restart the server.
114+
101115
# Payment integrations
102116

103117
By default this starter supports the following payment integrations

0 commit comments

Comments
 (0)