Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: update backend server guide #9987

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+25 −2
Open

feat: update backend server guide #9987

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c52288b
feat: update backend server guide
thetutlage Nov 8, 2024
9d590cf
refactor: add back the diagram and the intro text
thetutlage Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions www/apps/book/app/learn/deployment/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A standard Medusa project is made up of:

- Medusa application: The Medusa server and the Medusa Admin.
- One or more storefronts

![Diagram showcasing the connection between the three deployed components](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600807/Medusa%20Book/deployment-options_ceuuvo.jpg)

You can either deploy the Medusa application fully (server with the admin), or deploy the Medusa Admin separately. The storefront is always deployed separately.
Expand All @@ -25,14 +25,37 @@ You must deploy the Medusa server before the admin or storefront, as both of the

![Diagram showcasing how the Medusa server and its associated services would be deployed](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600972/Medusa%20Book/backend_deployment_pgexo3.jpg)

The Medusa server must be deployed to a hosting provider supporting Node.js server deployments, such as Railway, DigitalOcean, AWS, Heroku, etc…
The `npm run build` command will compile your Medusa backend server and create a static bundle for the Admin dashboard. The output is written inside the `.medusa/server` directory, and you can deploy this directory without relying on the original TypeScript source.

Following are the hypothetical steps for creating and running the production build. The actual setup may vary depending upon your deployment host. However, the goal is to follow the following steps and run the production server from within the `.medusa/server` directory.

<Note title="Tip">

For optimal experience, make sure that the hosting provider and plan offer at least 2GB of RAM.

</Note>

```sh
# First create a build
npm run build

# Cd into the output directory.

cd .medusa/server

# Install production dependencies

npm ci --omit=dev

# Define environment variables before you attempt to start the server

# Run production server

npx medusa start
```

### Additional services

Your server connects to a PostgreSQL database, Redis, and other services relevant for your setup. Most hosting providers support deploying and managing these databases along with your Medusa server (such as Railway and DigitalOcean).

Refer to [this reference](!resources!/deployment) to find how-to deployment guides for specific hosting providers.
Expand Down
Loading