964927b597
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
68 lines
1.7 KiB
Plaintext
68 lines
1.7 KiB
Plaintext
export const metadata = {
|
||
title: `${pageNumber} Next.js Starter`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this chapter, you’ll learn how to install and use the Next.js Starter storefront.
|
||
|
||
<Note type="soon">
|
||
|
||
The Next.js Starter is currently in development to fully support Medusa v2.
|
||
|
||
</Note>
|
||
|
||
## Install Next.js Starter
|
||
|
||
<Note type="check">
|
||
|
||
- [Node v18+](https://nodejs.org/en/)
|
||
- At least one region in the Medusa application.
|
||
|
||
</Note>
|
||
|
||
1. Clone the `v2` branch of the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa/tree/v2):
|
||
|
||
```bash
|
||
git clone https://github.com/medusajs/nextjs-starter-medusa -b v2 my-medusa-storefront
|
||
```
|
||
|
||
2. Change to the `my-medusa-storefront` directory, install the dependencies, and rename the template environment variable:
|
||
|
||
```bash npm2yarn
|
||
cd my-medusa-storefront
|
||
npm install
|
||
mv .env.template .env.local
|
||
```
|
||
|
||
3. While the Medusa application is running, start the Next.js storefront:
|
||
|
||
```bash npm2yarn
|
||
npm run dev
|
||
```
|
||
|
||
Your Next.js Starter Storefront is now running at `localhost:8000`.
|
||
|
||
---
|
||
|
||
## Customize Storefront
|
||
|
||
To customize the storefront, refer to the following directories:
|
||
|
||
- `src/app`: The storefront’s pages.
|
||
- `src/modules`: The storefront’s components.
|
||
- `src/styles`: The storefront’s styles.
|
||
|
||
<Note title="Tip">
|
||
|
||
You can learn more about development with Next.js through [their documentation](https://nextjs.org/docs/getting-started).
|
||
|
||
</Note>
|
||
|
||
---
|
||
|
||
## Configurations and Integrations
|
||
|
||
The Next.js Starter is compatible with some Medusa integrations out-of-the-box, such as the Stripe provider module. You can also change some of its configurations if necessary.
|
||
|
||
Refer to the [Next.js Starter reference](!resources!/nextjs-starter) for more details. |