mirror of
https://github.com/vercel/commerce.git
synced 2025-05-15 22:16:58 +00:00
cccf6afdeb
* Adds anchor for v1 note * Adds period --------- Co-authored-by: Lee Robinson <lrobinson2011@gmail.com>
71 lines
3.5 KiB
Markdown
71 lines
3.5 KiB
Markdown
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmedusajs%2Fvercel-commerce&env=MEDUSA_API_KEY,SITE_NAME,NEXT_PUBLIC_MEDUSA_BACKEND_API,NEXT_PUBLIC_VERCEL_URL,TWITTER_SITE,TWITTER_CREATOR&project-name=medusa-nextjs-commerce&repository-name=medusa-nextjs-commerce&redirect-url=https%3A%2F%2Fdocs.medusajs.com%2F%3Futm_source%3Dvercel%26utm_medium%3Ddeploy%2Bbutton%26utm_campaign%3Dcommerce&demo-title=Next.js%20Commerce%20by%20Medusa&demo-description=A%20Next.js%2013%20and%20ecommerce%20template%2C%20built%20with%20Medusa.&demo-url=https%3A%2F%2Fmedusa-nextjs-commerce.vercel.app%2F&demo-image=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62591822%3Fs%3D200%26v%3D4)
|
||
|
||
# Next.js Commerce x Medusa
|
||
|
||
> 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)
|
||
|
||
A Next.js 13 and App Router-ready ecommerce template, built with [Medusa](https://github.com/medusajs/medusa), featuring:
|
||
|
||
- Next.js App Router
|
||
- Optimized for SEO using Next.js's Metadata
|
||
- React Server Components (RSCs) and Suspense
|
||
- Server Actions for mutations
|
||
- Edge Runtime
|
||
- New fetching and caching paradigms
|
||
- Dynamic OG images
|
||
- Styling with Tailwind CSS
|
||
- Automatic light/dark mode based on system settings
|
||
|
||
## What is Medusa?
|
||
|
||
[Medusa](https://medusajs.com/) is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any system that needs foundational commerce primitives. All modules are open-source and freely available on NPM.
|
||
|
||
Learn more about [Medusa’s architecture](https://docs.medusajs.com/development/fundamentals/architecture-overview) and [commerce modules](https://docs.medusajs.com/modules/overview) in Medusa's documentation.
|
||
|
||
## Getting started
|
||
|
||
> Please refer to the [documentation](https://docs.medusajs.com/development/backend/install#prerequisites) to learn about required tools for the Medusa Backend.
|
||
|
||
1\. Run `create-medusa-app` with the `nextjs-commerce` starter:
|
||
|
||
```bash
|
||
npx create-medusa-app@nextjs-commerce
|
||
```
|
||
|
||
This will create a new main folder with two subfolders for Medusa and Next.js Commerce respectively.
|
||
|
||
2\. Create a Postgres database named `vercel-commerce` and make sure the Postgres server is running locally.
|
||
|
||
3\. Inside your newly created `nextjs-commerce` project, change to the `medusa` folder and seed the database:
|
||
|
||
```bash
|
||
cd nextjs-commerce/medusa
|
||
yarn seed
|
||
```
|
||
|
||
This will provide you with some demo products and the necessary product categories to fill out the homepage.
|
||
|
||
## Running Medusa
|
||
|
||
From the `medusa` subfolder, run:
|
||
|
||
```bash
|
||
yarn start
|
||
```
|
||
|
||
Your Medusa server should now be running on [localhost:9000](http://localhost:9000/).
|
||
|
||
## Running Next.js Commerce
|
||
|
||
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_MEDUSA_BACKEND_API environment variable points to your Medusa backend domain (default: http://localhost:9000).
|
||
|
||
> Note: You should not commit your `.env` file or it will expose secrets.
|
||
|
||
2\. From the `nextjs-commerce` subfolder, run:
|
||
|
||
```bash
|
||
yarn dev
|
||
```
|
||
|
||
Your app should now be running on [localhost:3000](http://localhost:3000/).
|