Quickstart

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

:::tip

For a more detailed guide on how to set up your local environment to work with Medusa, check out the documentation on how to set up your development environment.

:::

Prerequisites

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

node -v

You can install Node from the official website.

Create a Medusa Server

1. Install Medusa CLI

npm install -g @medusajs/medusa-cli

2. Create a new Medusa project

medusa new my-medusa-store --seed

3. Start your Medusa server

cd my-medusa-store
medusa develop

Test Your Server

After these 3 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

:::note

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

:::

Additional Steps

File Service Plugin

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

MinIO (Recommended for local development)
S3
DigitalOcean Spaces

Environment Variables

Medusa allows you to choose how to load your environment variables. By default, it will only load environment variables on your system.

If you want to load environment variables from a .env file add the following at the top of medusa-config.js:

const dotenv = require('dotenv')

 let ENV_FILE_NAME = '';
 switch (process.env.NODE_ENV) {
  case 'production':
    ENV_FILE_NAME = '.env.production';
    break;
  case 'staging':
    ENV_FILE_NAME = '.env.staging';
    break;
  case 'test':
    ENV_FILE_NAME = '.env.test';
    break;
  case 'development':
  default:
    ENV_FILE_NAME = '.env';
    break;
 }

 try {
  dotenv.config({ path: process.cwd() + '/' + ENV_FILE_NAME });
 } catch (e) {
 }

What's next 🚀

Install our Next.js or Gatsby storefronts to set up your ecommerce storefront quickly.
Install the Medusa Admin to supercharge your ecommerce experience with easy access to configurations and features.
Check our 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.

3.0 KiB Raw Blame History