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

docs: commented out option 2 of admin as a temporary fix (#3789)

Browse Source 
* docs: commented out option 2 as a temporary fix

* fix comments
This commit is contained in:
Shahed Nasser
2023-04-10 18:52:23 +03:00
committed by GitHub
parent a964bea801
commit 8da342897c
2 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/admin/development.md
View File

@@ -7,6 +7,12 @@ addHowToData: true
In this document, you’ll learn how to customize the Medusa admin by forking it, and how to keep it updated with changes from the main repository.
:::warning
This guide explains how to customize the Medusa Admin repository, which is now deprecated. This guide doesn't work with the [admin plugin](./quickstart.mdx).
:::
## Overview
Although Medusa provides an intuitive admin that should cover all your ecommerce needs, you are free to customize the Medusa admin as you see fit.

20
docs/content/admin/quickstart.mdx
View File

@@ -17,12 +17,16 @@ The admin dashboard is now shipped as an NPM package, and the previous GitHub re
## Overview
The admin dashboard is installed on the Medusa backend. Setting it up depends on how you intend to use it:
The admin dashboard is installed on the Medusa backend. The admin dashboard starts when you start the Medusa backend. This also means you can later deploy the Medusa backend along with the admin dashboard on the same hosting.
This guide will explain the steps and configurations required to set up the admin dashboard.
<!-- The admin dashboard is installed on the Medusa backend. Setting it up depends on how you intend to use it:
1. [Served alongside the Medusa backend](#option-1-install-and-serve-admin-with-the-backend): with this approach, the admin dashboard starts when you start the Medusa backend. This also means you can later deploy the Medusa backend along with the admin dashboard on the same hosting.
2. [Served separately from the Medusa backend](#option-2-install-and-serve-admin-separately): with this approach, the admin dashboard starts separately from the Medusa backend. You still need the Medusa backend to be running as the admin uses its APIs. This is useful if you intend to later deploy the admin dashboard on a different hosting than the Medusa Backend, such as using Vercel.
This guide will explain the steps and configurations required for both approaches.
This guide will explain the steps and configurations required for both approaches. -->
---
@@ -46,16 +50,20 @@ You can install Node from the [official website](https://nodejs.org/en/).
---
## Option 1: Install and Serve Admin with the Backend
<!-- ## Option 1: Install and Serve Admin with the Backend -->
## Install and Serve Admin with the Backend
This section explains how to install the admin to be served with the Medusa Backend and later deployed together.
:::note
<!-- :::note
If you decide later to serve the admin for development separately or deploy it on a different hosting, you can go back and follow the steps in [Option 2](#option-2-install-and-serve-admin-serparately).
:::
-->
### Step 1: Install the Package
In the directory of your Medusa backend, run the following command to install admin dashboard:
@@ -117,6 +125,8 @@ This starts the Medusa Backend and the admin dashboard. By default, the admin wi
---
<!--
## Option 2: Install and Serve Admin Separately
This section explains how to install the admin dashboard using approach 2, which allows you to serve and later deploy the admin separately.
@@ -173,6 +183,8 @@ This runs the admin dashboard on `localhost:7001`.
---
-->
## Demo Credentials
If you installed the demo data when you installed the Medusa backend by using the `--seed` option or running: