docs: document create-medusa-app new project name argument (#10834)

This commit is contained in:
Shahed Nasser
2025-01-07 15:02:55 +02:00
committed by GitHub
parent 936954e0b4
commit ff3df907ce
4 changed files with 29 additions and 6 deletions

View File

@@ -30,12 +30,12 @@ A Medusa application is made up of a Node.js server and an admin dashboard. You
To create a Medusa application, use the `create-medusa-app` command:
```bash
npx create-medusa-app@latest
npx create-medusa-app@latest my-medusa-store
```
When you run the command, you'll be asked for the project's name and whether you want to install the Next.js storefront.
Where `my-medusa-store` is the name of the project's directory and PostgreSQL database created for the project. When you run the command, you'll be asked whether you want to install the Next.js storefront.
After answering the prompts, the command installs the Medusa application in a directory with your project name, and prepares a PostgreSQL database that the application connects to.
After answering the prompts, the command installs the Medusa application in a directory with your project name, and sets up a PostgreSQL database that the application connects to.
If you chose to install the storefront with the Medusa application, the storefront is installed in a separate directory named `{project-name}-storefront`.

View File

@@ -106,7 +106,7 @@ export const generatedEditDates = {
"app/learn/build/page.mdx": "2024-12-09T11:05:17.383Z",
"app/learn/deployment/general/page.mdx": "2024-11-25T14:33:50.439Z",
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z",
"app/learn/installation/page.mdx": "2024-12-12T15:22:29.182Z",
"app/learn/installation/page.mdx": "2025-01-06T09:12:48.690Z",
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
"app/learn/fundamentals/module-links/link/page.mdx": "2025-01-06T09:27:25.604Z"
}

View File

@@ -35,9 +35,32 @@ The `create-medusa-app` CLI tool simplifies the process of creating a new Medusa
## Usage
```bash
npx create-medusa-app@latest
npx create-medusa-app@latest [project-name]
```
### Arguments
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Option</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`project-name`
</Table.Cell>
<Table.Cell>
The name of the project's directory and PostgreSQL database to be created. For example, `my-medusa-store`. If not provided, you'll be prompted to enter a project name.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Command Options
<Table>

View File

@@ -100,7 +100,7 @@ export const generatedEditDates = {
"app/commerce-modules/user/page.mdx": "2024-12-25T16:24:26.837Z",
"app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z",
"app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z",
"app/create-medusa-app/page.mdx": "2024-08-05T11:10:55+03:00",
"app/create-medusa-app/page.mdx": "2025-01-06T09:14:55.483Z",
"app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
"app/deployment/medusa-application/railway/page.mdx": "2024-11-11T11:50:10.517Z",
"app/deployment/storefront/vercel/page.mdx": "2025-01-06T12:19:31.142Z",