Files
medusa-store/docs/content/quickstart/quick-start.md
2022-04-18 15:17:27 +02:00

2.4 KiB

Quickstart

This quickstart is intended for experienced developers, that are accustomed with concepts like JavaScript, Node.js, SQL and the command line. For a more gentle introduction, see our tutorial 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

    medusa develop
    
  4. Use the API

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

After these four steps and only a couple of minutes, you now have a complete commerce engine running locally. You may now explore the documentation to learn how to interact with the Medusa API. You may also add plugins to your Medusa store by specifying them in your medusa-config.js file. We have a prebuilt admin dashboard that you can use to configure and manage your store find it here: Medusa Admin

What's next?

Set up a storefront for your Medusa project

We have created two starters for you that can help you lay a foundation for your storefront. The starters work with your new server with minimal configuration simply clone the starters from here:

Note: Medusa runs on port 9000 by default and the storefront starters are both configured to run on port 8000. If you wish to run your storefront starter on another port you should update your CORS settings in your project's medusa-config.js.