Skip to main content

Quickstart

This document will guide you through setting up your Medusa server in a few minutes.

Prerequisites

Medusa supports Node versions 14 and 16. You can check which version of Node you have by running the following command:

node -v
Copy to Clipboard

You can install Node from the official website.

Create a Medusa Server

1. Install Medusa CLI

npm install @medusajs/medusa-cli -g
Copy to Clipboard

If you run into any errors while installing the CLI tool, check out the troubleshooting guide.

2. Create a new Medusa project

medusa new my-medusa-store --seed
Copy to Clipboard

3. Start your Medusa server

cd my-medusa-store
medusa develop
Copy to Clipboard

Test Your Server

After these three steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line:

curl localhost:9000/store/products | python -m json.tool
Copy to Clipboard

This command uses Python to format the result of the request better in your command line. If you don't want to use Python you can simply send a request without the formatting:

curl localhost:9000/store/products
Copy to Clipboard

Additional Steps

Set Up Development Environment

For an optimal experience developing with Medusa and to make sure you can use its advanced functionalities, you'll need to install more tools such as Redis or PostgreSQL.

Follow this documentation to learn how to set up your development environment.

Server Configurations

It's important to configure your Medusa server properly and learn how environment variables are loaded.

You can learn more about configuring your server and loading environment variables in the Configure your Server documentation.

File Service Plugin

To upload product images to your Medusa server, you must install and configure one of the following file service plugins:

What's Next

  • Install the Next.js or Gatsby storefronts to set up your ecommerce storefront.
  • Install the Medusa Admin to supercharge your ecommerce experience with easy access to configurations and features.
  • Check out the API reference to learn more about available endpoints available on your Medusa server.
  • Install plugins for features like Payment, CMS, Notifications, among other features.