docs: add vale rule for Next.js Starter Storefront (#12517)

2025-05-16 17:30:15 +03:00
parent 5cd4ff6fe7
commit a1f2e5cb52
30 changed files with 22512 additions and 22510 deletions
@@ -88,7 +88,7 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-You'll first be asked for the project's name. Then, when asked whether you want to install the [Next.js starter storefront](../../../nextjs-starter/page.mdx), choose "Yes."
+You'll first be asked for the project's name. Then, when asked whether you want to install the [Next.js Starter Storefront](../../../nextjs-starter/page.mdx), choose "Yes."

 Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name and the Next.js Starter Storefront in a separate directory named `{project-name}-storefront`.

@@ -260,7 +260,7 @@ You define two methods:

 #### Search Method

-The last method you'll implement is a method to search through the Algolia index. You'll later use this method to expose the search functionality to clients, such as the Next.js Storefront.
+The last method you'll implement is a method to search through the Algolia index. You'll later use this method to expose the search functionality to clients, such as the Next.js Starter Storefront.

 Add the following method to the `AlgoliaModuleService` class:

@@ -1103,7 +1103,7 @@ You can use the search API route now. You'll see it in action as you customize t

 ---

-## Step 7: Search Products in Next.js Storefront
+## Step 7: Search Products in Next.js Starter Storefront

 The last step is to provide the search functionalities to customers on your storefront. In the first step, you installed the [Next.js Starter Storefront](../../../nextjs-starter/page.mdx) along with the Medusa application.

@@ -101,7 +101,7 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-First, you'll be asked for the project's name. Then, when prompted about installing the [Next.js starter storefront](../../../nextjs-starter/page.mdx), choose "Yes."
+First, you'll be asked for the project's name. Then, when prompted about installing the [Next.js Starter Storefront](../../../nextjs-starter/page.mdx), choose "Yes."

 Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name and the Next.js Starter Storefront in a separate directory named `{project-name}-storefront`.

@@ -71,7 +71,7 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-You'll be asked for the project's name. You can also optionally choose to install the [Next.js starter storefront](../../../nextjs-starter/page.mdx).
+You'll be asked for the project's name. You can also optionally choose to install the [Next.js Starter Storefront](../../../nextjs-starter/page.mdx).

 Afterward, the installation process will start, which will install the Medusa application in a directory with your project's name. If you chose to install the Next.js starter, it'll be installed in a separate directory with the `{project-name}-storefront` name.

@@ -75,9 +75,9 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js storefront, choose `Y` for yes.
+You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js Starter Storefront, choose `Y` for yes.

-Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js storefront in a directory with the `{project-name}-storefront` name.
+Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js Starter Storefront in a directory with the `{project-name}-storefront` name.

 <Note title="Why is the storefront installed separately?">

@@ -87,7 +87,7 @@ The Medusa application is composed of a headless Node.js server and an admin das

 Once the installation finishes successfully, the Medusa Admin dashboard will open with a form to create a new user. Enter the user's credential and submit the form. Afterwards, you can login with the new user and explore the dashboard.

-The Next.js storefront is also running at `http://localhost:8000`.
+The Next.js Starter Storefront is also running at `http://localhost:8000`.

 <Note title="Ran to Errors?">

@@ -1331,7 +1331,7 @@ This subscriber now runs whenever an order is placed. You'll see this in action

 ## Test it Out: Place an Order

-To test out the Resend integration, you'll place an order using the [Next.js storefront](../../../nextjs-starter/page.mdx) that you installed as part of installing Medusa.
+To test out the Resend integration, you'll place an order using the [Next.js Starter Storefront](../../../nextjs-starter/page.mdx) that you installed as part of installing Medusa.

 Start your Medusa application first:

@@ -1339,7 +1339,7 @@ Start your Medusa application first:
 npm run dev
 ```

-Then, in the Next.js storefront's directory (which was installed in a directory outside of the Medusa application's directory with the name `{project-name}-storefront`, where `{project-name}` is the name of the Medusa application's directory), run the following command to start the storefront:
+Then, in the Next.js Starter Storefront's directory (which was installed in a directory outside of the Medusa application's directory with the name `{project-name}-storefront`, where `{project-name}` is the name of the Medusa application's directory), run the following command to start the storefront:

 ```bash npm2yarn
 npm run dev
@@ -76,9 +76,9 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js storefront, choose `Y` for yes.
+You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js Starter Storefront, choose `Y` for yes.

-Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js storefront in a directory with the `{project-name}-storefront` name.
+Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js Starter Storefront in a directory with the `{project-name}-storefront` name.

 <Note title="Why is the storefront installed separately?">

@@ -88,7 +88,7 @@ The Medusa application is composed of a headless Node.js server and an admin das

 Once the installation finishes successfully, the Medusa Admin dashboard will open with a form to create a new user. Enter the user's credential and submit the form.

-Afterwards, you can login with the new user and explore the dashboard. The Next.js storefront is also running at `http://localhost:8000`.
+Afterwards, you can login with the new user and explore the dashboard. The Next.js Starter Storefront is also running at `http://localhost:8000`.

 <Note title="Ran to Errors?">

@@ -979,7 +979,7 @@ In the next step, you'll setup Sanity with Next.js, and you can then monitor the

 ## Step 8: Setup Sanity with Next.js Starter Storefront

-In this step, you'll install Sanity in the Next.js Starter and configure it. You'll then have a Sanity studio in your Next.js storefront, where you'll later view the product documents being synced from Medusa, and update their content that you'll display in the storefront on the product details page.
+In this step, you'll install Sanity in the Next.js Starter and configure it. You'll then have a Sanity studio in your Next.js Starter Storefront, where you'll later view the product documents being synced from Medusa, and update their content that you'll display in the storefront on the product details page.

 Sanity has a CLI tool that helps you with the setup. First, change to the Next.js Starter's directory (it's outside the Medusa application's directory and its name is `{project-name}-storefront`, where `{project-name}` is the name of the Medusa application's directory).

@@ -1178,7 +1178,7 @@ You add the product schema to the list of exported schemas, but also disable cre

 ### Test it Out

-To ensure that your schema is defined correctly and working, start the Next.js storefront's server, and open the Sanity studio again at `http://localhost:8000/studio`.
+To ensure that your schema is defined correctly and working, start the Next.js Starter Storefront's server, and open the Sanity studio again at `http://localhost:8000/studio`.

 You'll find "Product Page" under Content. If you click on it, you'll find any product you've synced from Medusa.

@@ -81,9 +81,9 @@ Start by installing the Medusa application on your machine with the following co
 npx create-medusa-app@latest
 ```

-You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js storefront, choose `Y` for yes.
+You'll first be asked for the project's name. Then, when you're asked whether you want to install the Next.js Starter Storefront, choose `Y` for yes.

-Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js storefront in a directory with the `{project-name}-storefront` name.
+Afterwards, the installation process will start, which will install the Medusa application in a directory with your project's name, and the Next.js Starter Storefront in a directory with the `{project-name}-storefront` name.

 <Note title="Why is the storefront installed separately?">

@@ -93,7 +93,7 @@ The Medusa application is composed of a headless Node.js server and an admin das

 Once the installation finishes successfully, the Medusa Admin dashboard will open with a form to create a new user. Enter the user's credential and submit the form.

-Afterwards, you can login with the new user and explore the dashboard. The Next.js storefront is also running at `http://localhost:8000`.
+Afterwards, you can login with the new user and explore the dashboard. The Next.js Starter Storefront is also running at `http://localhost:8000`.

 <Note title="Ran to Errors?">