docs: improve installation documentation with diagrams (#12312)

This commit is contained in:
Shahed Nasser
2025-04-28 19:43:28 +03:00
committed by GitHub
parent f31013104b
commit c1e6b81972
3 changed files with 16523 additions and 16511 deletions

View File

@@ -39,6 +39,8 @@ After answering the prompts, the command installs the Medusa application in a di
If you chose to install the storefront with the Medusa application, the storefront is installed in a separate directory named `{project-name}-storefront`.
![Diagram showcasing an overview of the installation directories](https://res.cloudinary.com/dza7lstvk/image/upload/v1745856132/Medusa%20Resources/installation-dirs_x8jux4.jpg)
### Successful Installation Result
Once the installation finishes successfully, the Medusa application will run at `http://localhost:9000`.
@@ -49,6 +51,8 @@ If you also installed the Next.js storefront, it'll be running at `http://localh
You can stop the servers for the Medusa application and Next.js storefront by exiting the installation command. To run the server for the Medusa application again, refer to [this section](#run-medusa-application-in-development).
![Diagram showcasing the server and applications running after successful installation](https://res.cloudinary.com/dza7lstvk/image/upload/v1745856706/Medusa%20Resources/success-overview_bj4pbt.jpg)
### Troubleshooting Installation Errors
If you ran into an error during your installation, refer to the following troubleshooting guides for help:
@@ -77,7 +81,9 @@ To run the Medusa application in development, change to your application's direc
npm run dev
```
This runs your Medusa application at `http://localhost:9000`, and the Medusa Admin dashboard `http://localhost:9000/app`.
This runs your Medusa server at `http://localhost:9000`, and the Medusa Admin dashboard `http://localhost:9000/app`.
![Diagram showcasing the server and application running when you start the Medusa application](https://res.cloudinary.com/dza7lstvk/image/upload/v1745856966/Medusa%20Resources/start-overview_aetplx.jpg)
<Note title="Tip">

View File

@@ -97,7 +97,7 @@ export const generatedEditDates = {
"app/learn/build/page.mdx": "2025-04-25T12:34:33.914Z",
"app/learn/deployment/general/page.mdx": "2025-04-17T08:29:09.878Z",
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z",
"app/learn/installation/page.mdx": "2025-04-25T12:33:42.096Z",
"app/learn/installation/page.mdx": "2025-04-28T16:16:39.357Z",
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
"app/learn/fundamentals/module-links/link/page.mdx": "2025-04-07T08:03:14.513Z",
"app/learn/fundamentals/workflows/store-executions/page.mdx": "2025-04-17T08:29:10.166Z",

File diff suppressed because it is too large Load Diff