Files
medusa-store/docs/content/quickstart/quick-start.md

2.0 KiB

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.

Getting started

  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 engine

    cd my-medusa-store
    medusa develop
    

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

:::

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.