This document will guide you through setting up your Medusa backend in a three steps.
Before you can install and use Medusa, you need the following tools installed on your machine:
Create a Medusa Backend
1. Install Medusa CLI
To install the Medusa backend, you need Medusa's CLI tool. You can install it globally or, alternatively, use it through npx with
npx @medusajs/medusa-cli <command>.
2. Create a new Medusa project
You'll then be asked to specify your PostgreSQL database credentials. You can choose "Continue" to use the default credentials shown in the terminal, choose "Change credentials" to specify your PostgreSQL credentials, or choose "Skip database setup" to create the database later.
3. Start your Medusa backend
Make sure your PostgreSQL server is running before you run the Medusa backend.
After these three 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:
Error: SASL: SCRAM-SERVER-FIRST-MESSAGE: Client password must be a string
Can't Connect to PostgreSQL Docker Container
Error: connect ECONNREFUSED ::1:5432
AwilixResolutionError: Could Not Resolve X
For better testing, you can add demo data to your Medusa backend by running the seed command in your Medusa backend directory:
You can access
/health to get health status of your backend.
Learn about the purpose of each file and directory in the Medusa backend.
Learn about configuring your backend and loading environment variables.
Learn about the different resources that your Medusa backend is made of.