docs: general updates and fixes (#13374)

* docs: general updates and fixes

* fix lint errors
This commit is contained in:
Shahed Nasser
2025-09-02 09:07:07 +03:00
committed by GitHub
parent c717535ca2
commit 24199fa47a
25 changed files with 477 additions and 396 deletions
@@ -11,20 +11,20 @@ export const metadata = {
# {metadata.title}
Create a standalone build of the Medusa application.
Create a standalone build of the Medusa application that you can deploy to production.
This creates a build that:
- Doesn't rely on the source TypeScript files.
- Can be copied to a production server reliably.
The build is outputted to a new `.medusa/server` directory.
The build is output to a new `.medusa/server` directory.
```bash
npx medusa build
```
Refer to [this section](#run-built-medusa-application) for next steps.
Refer to the [Build Medusa Application](!docs!/learn/build) guide for next steps.
## Options
@@ -44,7 +44,7 @@ Refer to [this section](#run-built-medusa-application) for next steps.
</Table.Cell>
<Table.Cell>
Whether to only build the admin to host it separately. If this option is not passed, the admin is built to the `.medusa/server/public/admin`. When this option is passed, the admin is built to the `.medusa/admin` directory instead.
Whether to build only the admin to host it separately. If this option is not passed, the admin is built to the `.medusa/server/public/admin` directory. When this option is passed, the admin is built to the `.medusa/admin` directory instead.
</Table.Cell>
</Table.Row>
@@ -53,38 +53,8 @@ Refer to [this section](#run-built-medusa-application) for next steps.
---
## Run Built Medusa Application
After running the `build` command, use the following step to run the built Medusa application:
- Change to the `.medusa/server` directory and install the dependencies:
```bash npm2yarn
cd .medusa/server && npm install
```
- When running the application locally, make sure to copy the `.env` file from the root project's directory. In production, use system environment variables instead.
```bash npm2yarn
cp .env .medusa/server/.env.production
```
- In the system environment variables, set `NODE_ENV` to `production`:
```bash
NODE_ENV=production
```
- Use the `start` command to run the application:
```bash npm2yarn
cd .medusa/server && npm run start
```
---
## Build Medusa Admin
By default, the Medusa Admin is built to the `.medusa/server/public/admin` directory.
If you want a separate build to host the admin standalone, such as on Vercel, pass the `--admin-only` option as explained in the [Options](#options) section. This outputs the admin to the `.medusa/admin` directory instead.
If you want a separate build to host the admin as a standalone application, such as on Vercel, pass the `--admin-only` option as explained in the [Options](#options) section. This outputs the admin to the `.medusa/admin` directory instead.