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

docs: added details about the stable option (#4632)

Browse Source 
* docs: added details about the stable option

* fix link
This commit is contained in:
Shahed Nasser
2023-07-28 17:55:23 +03:00
committed by GitHub
parent 5d71a8d26f
commit c8ef0c6d25
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/create-medusa-app.mdx
View File

@@ -29,10 +29,7 @@ Medusa is a toolkit for developers to create digital commerce applications. In i
:::note
`create-medusa-app` uses a beta version of the admin dashboard. If you want to use a stable Medusa setup, you can install the stable backend and the admin using the following guides:
1. [Install Medusa backend](./development/backend/install.mdx)
2. [Install admin package](./admin/quickstart.mdx)
`create-medusa-app` uses a beta version of the Medusa backend and admin. If you want to use a stable Medusa setup, consider passing the `--stable` option to the command. However, when using this option, you'll have to [install the Medusa admin](./admin/quickstart.mdx) manually.
:::
@@ -85,6 +82,7 @@ In your terminal, run the following command:
<details>
<summary>Available Options</summary>
- `--stable`: A flag that allows you to opt-out of the beta Medusa backend project. When using this option, the Medusa admin won't be installed.
- `--repo-url <url>`: The repository URL to create the project from. By default it will be `https://github.com/medusajs/medusa-starter-default`.
- `--seed`: A flag indicating whether the database should be seeded with demo data. By default, seeding is disabled.
- `--no-boilerplate`: A flag that removes all files added for an enhanced onboarding experience (files under `src/admin`, `src/api`, etc...). This is helpful if you want to create a clean project, and is only recommended if you're familiar with Medusa.
@@ -118,6 +116,12 @@ After the above steps, the project setup will start which includes:
### Step 5: Log into admin dashboard
:::note
If you passed the `--stable` option, the `localhost:9000/store/products` endpoint will open in your browser instead.
:::
Once the project is prepared, the Medusa backend will start and the admin dashboard will be opened in your default browser. You'll then be asked to enter a password for the admin email you entered earlier, as well as other account information.
Once you're logged in, you can start using Medusa! Try following the setup guide to create your first product and order.