asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: change naming of Next.js starter (#4494)

Browse Source
This commit is contained in:
Shahed Nasser
2023-07-11 11:35:08 +03:00
committed by GitHub
parent 4b4296dc16
commit fbece1d27e
39 changed files with 97 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/plugins/analytics/segment.md
View File

@@ -133,7 +133,7 @@ Run your backend with the following command:
npx @medusajs/medusa-cli develop
```
Then, try triggering one of the [mentioned events earlier in this document](#events-that-the-segment-plugin-tracks). For example, you can place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [Next.js starter storefront](../../starters/nextjs-medusa-starter.mdx).
Then, try triggering one of the [mentioned events earlier in this document](#events-that-the-segment-plugin-tracks). For example, you can place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx).
After you place an order, on the Segment source that you created, click on the Debugger tab. You should see at least one event triggered for each order you place. If you click on the event, you can see the order details are passed to the event.

2
docs/content/plugins/cms/contentful/customize-contentful.md
View File

@@ -9,7 +9,7 @@ In this document, you’ll learn how to customize the Contentful integration wit
:::warning
This guide covers how to customize the Gatsby storefront which is now deprecated. It's recommended to integrate Contentful into either the Next.js storefront or your custom storefront.
This guide covers how to customize the Gatsby storefront which is now deprecated. It's recommended to integrate Contentful into either the Next.js Starter Template or your custom storefront.
:::

2
docs/content/plugins/cms/contentful/index.md
View File

@@ -227,7 +227,7 @@ To do that:
:::warning
This Gatsby storefront is deprecated. It's recommended to integrate Contentful into either the Next.js storefront or your custom storefront.
This Gatsby storefront is deprecated. It's recommended to integrate Contentful into either the Next.js Starter Template or your custom storefront.
:::

4
docs/content/plugins/file-service/local.md
View File

@@ -72,9 +72,9 @@ The files will be stored under the `upload_dir` specified in the plugin options
---
## Next.js Storefront Configuration
## Next.js Starter Template Configuration
If you’re using a [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront, you need to add an additional configuration that adds the backend's domain name into the configured images domain names. This is because all URLs of product images will be from the Medusa backend.
If you’re using a [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx), you need to add an additional configuration that adds the backend's domain name into the configured images domain names. This is because all URLs of product images will be from the Medusa backend.
If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host).

4
docs/content/plugins/file-service/minio.md
View File

@@ -193,9 +193,9 @@ const plugins = [
---
## Next.js Storefront Configuration
## Next.js Starter Template Configuration
If you’re using a [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront, you need to add an additional configuration that adds the MinIO domain name into the configured images domain names. This is because all URLs of product images will be from the MinIO backend.
If you’re using a [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx), you need to add an additional configuration that adds the MinIO domain name into the configured images domain names. This is because all URLs of product images will be from the MinIO backend.
If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host).

8
docs/content/plugins/file-service/s3.mdx
View File

@@ -195,9 +195,9 @@ You can also check that the image was uploaded on the S3 bucket’s page.
---
## Next.js Storefront Configuration
## Next.js Starter Template Configuration
If you’re using a [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront, you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket.
If you’re using a [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx), you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket.
If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host).
@@ -238,6 +238,6 @@ Where `<BUCKET_NAME>` is the name of the S3 bucket you’re using.
## See Also
- Check out [more plugins](../overview.mdx) you can add to your store.
- Check out [more plugins](../overview.mdx) you can add to your store
- [Deploy the Medusa backend](../../deployments/server/index.mdx)
- Install the [Next.js](../../starters/nextjs-medusa-starter.mdx) starter storefront.
- Install the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx)

10
docs/content/plugins/file-service/spaces.md
View File

@@ -152,9 +152,9 @@ You can also check that the image was uploaded on the Space’s page.
---
## Next.js Storefront Configuration
## Next.js Starter Template Configuration
If you’re using a [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront, you need to add an additional configuration that adds the Space’s domain name into the configured images’ domain names. This is because all URLs of product images will be from the Space.
If you’re using a [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx), you need to add an additional configuration that adds the Space’s domain name into the configured images’ domain names. This is because all URLs of product images will be from the Space.
If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host).
@@ -182,6 +182,6 @@ Where `<YOUR_SPACE_DOMAIN>` is the domain name for your Space which can be retri
## See Also
- Check out [more plugins](../overview.mdx) you can add to your store.
- [Deploy the Medusa backend on DigitalOcean](../../deployments/server/deploying-on-digital-ocean.md).
- Install the [Next.js](../../starters/nextjs-medusa-starter.mdx) starter storefront.
- Check out [more plugins](../overview.mdx) you can add to your store
- [Deploy the Medusa backend on DigitalOcean](../../deployments/server/deploying-on-digital-ocean.md)
- Install the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx)

2
docs/content/plugins/notifications/sendgrid.mdx
View File

@@ -3969,7 +3969,7 @@ To test it out, perform an action that would trigger one of the emails being sen
:::tip
If you don’t have a storefront installed, check out the [Next.js](../../starters/nextjs-medusa-starter.mdx) starter storefront.
If you don’t have a storefront installed, check out the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx).
:::

2
docs/content/plugins/notifications/slack.md
View File

@@ -103,4 +103,4 @@ That’s all you need to do to integrate Slack into Medusa!
## See Also
- Install [Medusa's Admin](../../admin/quickstart.mdx) for the full order-management experience.
- Install the [Next.js](../../starters/nextjs-medusa-starter.mdx) starter storefront.
- Install the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx).

2
docs/content/plugins/notifications/twilio-sms.md
View File

@@ -127,7 +127,7 @@ If you create an order now on your storefront, you should receive a message from
:::tip
If you don’t have a storefront set up yet, you can install the [Next.js starter storefront](../../starters/nextjs-medusa-starter.mdx).
If you don’t have a storefront set up yet, you can install the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx).
:::

6
docs/content/plugins/payment/paypal.md
View File

@@ -109,7 +109,7 @@ All storefronts require that you obtain your PayPal Client ID. You can retrieve
### Process Overview
Aside from the Next.js Storefront, you need to add the implementation with PayPal manually.
Aside from the Next.js Starter Template, you need to add the implementation with PayPal manually.
:::note
@@ -130,9 +130,9 @@ In Medusa, by default, payments are authorized during checkout, but the payment
:::
### Add to Next.js Storefront
### Add to Next.js Starter Template
Medusa has a Next.js storefront that you can easily use with your Medusa backend. If you don’t have the storefront installed, you can follow [this quickstart guide](../../starters/nextjs-medusa-starter.mdx).
Medusa has a Next.js Starter Template that you can easily use with your Medusa backend. If you don’t have the storefront installed, you can follow [this quickstart guide](../../starters/nextjs-medusa-starter.mdx).
In your `.env.local` file (or the file you’re using for your environment variables), add the following variable:

4
docs/content/plugins/payment/stripe.mdx
View File

@@ -139,9 +139,9 @@ This guide will take you through how to set up Stripe payments in your Medusa st
All storefronts require that you obtain your Stripe’s Publishable Key. You can retrieve it from your Stripe’s developer dashboard by choosing API Keys and then copying the Publishable Key.
### Add to Next.js Storefront
### Add to Next.js Starter Template
Medusa has a Next.js storefront that you can easily use with your Medusa backend. If you don’t have the storefront installed, you can follow [this quickstart guide](../../starters/nextjs-medusa-starter).
Medusa has a Next.js Starter Template that you can easily use with your Medusa backend. If you don’t have the storefront installed, you can follow [this quickstart guide](../../starters/nextjs-medusa-starter).
In your `.env.local` file (or the file you’re using for your environment variables), add the following variable:

14
docs/content/plugins/search/algolia.md
View File

@@ -225,7 +225,7 @@ This feature is only available if you have an event module installed in your Med
## Add Search to your Storefront
In this section, you’ll learn how to add the UI on your storefront to allow searching with Algolia. This section has instructions for Medusa’s [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront as well as React-based frameworks.
In this section, you’ll learn how to add the UI on your storefront to allow searching with Algolia. This section has instructions for Medusa’s [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx) as well as React-based frameworks.
### Storefront Prerequisites
@@ -233,13 +233,13 @@ It is assumed you already have a storefront set up and working with the Medusa b
:::tip
If you don’t have a storefront set up, you can use the [Next.js starter storefront](../../starters/nextjs-medusa-starter.mdx) that Medusa provides.
If you don’t have a storefront set up, you can use the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx) that Medusa provides.
:::
### Add to Next.js Storefront
### Add to Next.js Starter Template
The Next.js storefront has the Algolia integration available out of the box. To get it working, you just need to follow three steps.
The Next.js Starter Template has the Algolia integration available out of the box. To get it working, you just need to follow three steps.
First, ensure that the search feature is enabled in `store.config.json`:
@@ -277,15 +277,15 @@ export const SEARCH_INDEX_NAME =
process.env.NEXT_PUBLIC_INDEX_NAME || "products"
```
If you run your Next.js storefront now while the Medusa backend is running, the search functionality will be available in your storefront.
If you run your Next.js Starter Template now while the Medusa backend is running, the search functionality will be available in your storefront.
:::note
To make sure the Next.js storefront properly displays the products in the search result, include in the `attributesToRetrieve` setting of the Algolia plugin on the Medusa backend at least the fields `title`, `handle`, `description`, and `thumbnail`.
To make sure the Next.js Starter Template properly displays the products in the search result, include in the `attributesToRetrieve` setting of the Algolia plugin on the Medusa backend at least the fields `title`, `handle`, `description`, and `thumbnail`.
:::
![Search pop up in the Next.js storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000082/Medusa%20Docs/Algolia/1f9qqK6_c0z8zi.png)
![Search pop up in the Next.js Starter Template](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000082/Medusa%20Docs/Algolia/1f9qqK6_c0z8zi.png)
### Add to Other Storefronts

14
docs/content/plugins/search/meilisearch.md
View File

@@ -186,7 +186,7 @@ This feature is only available if you have an event module installed in your Med
## Add Search to your Storefront
In this section, you’ll learn how to add the UI on your storefront to allow searching with MeiliSearch. This section has instructions for Medusa’s [Next.js](../../starters/nextjs-medusa-starter.mdx) storefront as well as React-based frameworks.
In this section, you’ll learn how to add the UI on your storefront to allow searching with MeiliSearch. This section has instructions for Medusa’s [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx) as well as React-based frameworks.
### Storefront Prerequisites
@@ -194,7 +194,7 @@ It is assumed you already have a storefront set up and working with the Medusa b
:::tip
If you don’t have a storefront set up, you can use the [Next.js starter storefront](../../starters/nextjs-medusa-starter.mdx) that Medusa provides.
If you don’t have a storefront set up, you can use the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx) that Medusa provides.
:::
@@ -217,9 +217,9 @@ Make sure to replace `<MEILISEARCH_HOST>` and `<MEILISEARCH_MASTER_KEY>` accordi
If this request is successful, the API key will be available under the `key` property returned in the JSON response.
### Add to Next.js Storefront
### Add to Next.js Starter Template
The Next.js storefront has the MeiliSearch integration available out of the box. To get it working, you just need to follow two steps.
The Next.js Starter Template has the MeiliSearch integration available out of the box. To get it working, you just need to follow two steps.
First, ensure that the search feature is enabled in `store.config.json`:
@@ -241,15 +241,15 @@ NEXT_PUBLIC_SEARCH_INDEX_NAME=products
Make sure to replace `<YOUR_MEILISEARCH_HOST>` with your MeiliSearch host and `<YOUR_API_KEY>` with the API key you created as instructed in the [Storefront Prerequisites](#storefront-prerequisites) section.
If you run your Next.js storefront now while the Medusa backend and the MeiliSearch services are running, the search functionality will be available in your storefront.
If you run your Next.js Starter Template now while the Medusa backend and the MeiliSearch services are running, the search functionality will be available in your storefront.
:::note
To make sure the Next.js storefront properly displays the products in the search result, include in the `displayedAttributes` setting of the MeiliSearch plugin on the Medusa backend at least the fields `title`, `handle`, `description`, and `thumbnail`.
To make sure the Next.js Starter Template properly displays the products in the search result, include in the `displayedAttributes` setting of the MeiliSearch plugin on the Medusa backend at least the fields `title`, `handle`, `description`, and `thumbnail`.
:::
![Search Result on Next.js storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000298/Medusa%20Docs/MeiliSearch/gQVWvH2_datei5.png)
![Search Result on Next.js Starter Template](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000298/Medusa%20Docs/MeiliSearch/gQVWvH2_datei5.png)
### Add to Other Storefronts