README

Medusa



  Documentation |
  Website



  Building blocks for digital commerce


  
    
  
  
    
  
  
    
  
  
    
  


Medusa is an open-source commerce platform with a built-in framework for customization. Use it to build B2B or DTC stores, marketplaces, distributor platforms, PoS systems, and other applications that need commerce primitives such as products, carts, orders, and payments, without reinventing core commerce logic.

 Getting Started

The fastest way to get started is with Medusa Cloud, a managed environment for Medusa applications with automated deployments, scaling, and maintenance. Get started on Medusa Cloud.

To create a Medusa application locally, you need Node.js v22.22.0 or later and a running PostgreSQL database. Then run:

bash
npx create-medusa-app@latest my-medusa-store


This sets up the Medusa server and admin dashboard, and optionally the Next.js Starter Storefront. See the installation guide for all options, or install with Docker.

 Repository structure

This is a Yarn workspaces monorepo. Every Medusa package published to npm lives under packages.

| Path | Contents |
| --- | --- |
| packages/medusa | @medusajs/medusa: the main package installed in Medusa applications. Holds the Store and Admin API routes, CLI commands, subscribers, and jobs, and re-exports the modules and @medusajs/core-flows. |
| packages/core/ | Core libraries: the framework runtime (framework), types, utils, Workflows SDK, Modules SDK, predefined workflows (core-flows), Query, orchestration, and the JS SDK. |
| packages/modules/ | Commerce Modules (product, cart, order, pricing, payment, and more) and Infrastructure Modules (event bus, caching, file, locking, workflow engine, and more). |
| packages/modules/providers/ | Module Providers, such as Stripe payments, S3 file storage, SendGrid notifications, Redis locking and caching, and auth providers for email/password, GitHub, Google, and OIDC. |
| packages/admin/ | The Medusa Admin dashboard and the SDK, Vite plugin, and bundler used to build and extend it. |
| packages/design-system/ | Medusa UI: the React component library, icons, Tailwind preset, and a Figma import tool. |
| packages/cli/ | CLI tools: create-medusa-app, the medusa CLI, OpenAPI tooling, and the HTTP types generator. |
| packages/plugins/ | Official plugins, such as draft orders and loyalty. |
| integration-tests | HTTP and module integration test suites run against a real PostgreSQL database. |
| www | The source of the Medusa documentation website. |

 About Medusa

Medusa's commerce modules are open-source and freely available on npm. Enterprise Edition features are identified separately in the repository.

Learn more about Medusa's architecture and Commerce Modules in the documentation.

 Upgrades & Integrations

Follow the Release Notes to keep your Medusa project up-to-date.

Check out all available Medusa integrations.

 Community & Contributions

The core team is available in GitHub Discussions, where you can cr

Top issues

Discussions

Latest release

Highlights

 TypeScript 7 Support

Medusa's framework and CLI now support TypeScript 7 in applications and plugins. If you use TypeScript 7, make sure to also install @typescript/typescript6 as TypeScript 7 still doesn't support JavaScript APIs:

bash
yarn add -D typescript@7 @typescript/typescript6


17660

---

 Features

   feat(test-utils): add a Jest preset for Medusa applications and plugins by @shahednasser in 17673
   feat(framework,cli): support TypeScript 7 in Medusa applications and plugins by @shahednasser in 17660

 Bugs

   fix(dashboard): keep list filters a