Files

Oliver Windall Juhl f76aa816a5 feat: Documentation and API reference (#348 )

Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com>
Co-authored-by: zakariasaad <zakaria.elas@gmail.com>
Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com>
Co-authored-by: Kasper <kasper@medusa-commerce.com>
Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

2021-08-24 18:16:42 +02:00

1.8 KiB

Raw Blame History

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.

Getting started

Install Medusa CLI
```
npm install -g @medusajs/medusa-cli
```
Create a new Medusa project
```
medusa new my-medusa-store --seed
```
Start your Medusa engine
```
medusa develop
```

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.

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:

Link you local development to Medusa Cloud (Coming soon!)

With your project in local development you can link your Medusa instance to Medusa Cloud - this will allow you to manage your store, view orders and test out the amazing functionalities that you are building. Get started here.

1.8 KiB Raw Blame History