docs: improvements to admin, query, and read-only link docs (#12239)

* improve admin page

* improvemens to query and read-only link docs

* fix build error
This commit is contained in:
Shahed Nasser
2025-04-18 14:41:25 +03:00
committed by GitHub
parent 9167352778
commit 750b1e9bbf
9 changed files with 17201 additions and 17223 deletions
@@ -1,83 +0,0 @@
import { Prerequisites } from "docs-ui"
export const metadata = {
title: `${pageNumber} Next.js Starter Storefront`,
}
# {metadata.title}
The Medusa application is made up of a Node.js server and an admin dashboard. The storefront is installed and hosted separately from the Medusa application, giving you the flexibility to choose the frontend tech stack that you and your team are proficient in, and implement unique design systems and user experience.
The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or build on top of it to tailor it for the business's unique use case, design, and customer experience.
In this chapter, youll learn how to install the Next.js Starter storefront separately from the Medusa application. You can also install it while installing the Medusa application as explained in [the installation chapter](../../installation/page.mdx).
## Install Next.js Starter
<Prerequisites items={[
{
text: "Node.js v20+",
link: "https://nodejs.org/en/download"
},
{
text: "Git CLI tool",
link: "https://git-scm.com/downloads"
},
{
text: "At least one region in the Medusa application.",
},
]} />
If you already have a Medusa application installed with at least one region, you can install the Next.js Starter storefront with the following steps:
1. Clone the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa):
```bash
git clone https://github.com/medusajs/nextjs-starter-medusa my-medusa-storefront
```
2. Change to the `my-medusa-storefront` directory, install the dependencies, and rename the template environment variable file:
```bash npm2yarn
cd my-medusa-storefront
npm install
mv .env.template .env.local
```
3. Set the Medusa application's publishable API key in the `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY` environment variable. You can retrieve the publishable API key in on the Medusa Admin dashboard by going to Settings -> Publishable API Keys
```bash
NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_123...
```
4. While the Medusa application is running, start the Next.js Starter storefront:
```bash npm2yarn
npm run dev
```
Your Next.js Starter storefront is now running at `http://localhost:8000`.
---
## Customize Storefront
To customize the storefront, refer to the following directories:
- `src/app`: The storefronts pages.
- `src/modules`: The storefronts components.
- `src/styles`: The storefronts 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.