Prepare Development Environment
This document includes the installation instructions for the tools required to use and run Medusa.
Node.js
Node.js is the environment that makes it possible for Medusa to run, so you must install Node.js on your machine to start Medusa development.
Medusa requires version 16.14.0 or higher of Node. You can check your Node version using the following command:
node -v
- Windows
- Linux
- macOS
You can install the executable directly from the Node.js website.
For other approaches, you can check out Node.js’s guide.
You can use the following commands to install Node.js on Ubuntu:
For other Linux distributions, you can check out Node.js’s guide.
You can use the following commands to install Node.js on macOS:
For other approaches, you can check out Node.js’s guide.
Make sure that you have Xcode command line tools installed. If not, run the following command to install it: xcode-select --install
.
Git
Medusa uses Git behind the scenes when you create a new project. So, you'll have to install it on your machine to get started.
- Windows
- Linux
- macOS
To install Git on Windows, you need to download the installable package.
For Debian/Ubuntu, you can use the following command:
As for other Linux distributions, please check git’s guide.
You should already have Git installed as part of the Xcode command-line tools.
However, if for any reason you need to install it manually, you can install it with Homebrew:
You can also check out git’s guide for more installation options.
PostgreSQL
The Medusa backend uses PostgreSQL to store data of your commerce system.
- Windows
- Linux
- macOS
You can download the PostgreSQL Windows installer from their website.
If you’re using Ubuntu, you can use the following commands to download and install PostgreSQL:
For other distributions, you can check out PostgreSQL’s website for more guides.
You can download PostgreSQL on your macOS using the installer on their website.
(Optional) Medusa CLI
Medusa provides a CLI tool that can aid your through your Medusa development. You can install it globally, or you can use it through npx
.
You can install Medusa’s CLI with the following command:
To confirm that the CLI tool was installed successfully, run the following command:
medusa -v
Troubleshooting Installation
NPM Error: EACCES Permissions Errors
Powershell Error: command not found: medusa
Yarn Error: command not found: medusa
Install Medusa Backend
Once you're done installing the necessary tools in your environment, check out the Medusa Backend Quickstart to install your Medusa backend.