Medusa Examples

The Medusa Next.js Starter is a performant storefront built with Next.js 15, Tailwind CSS, and TypeScript. It is designed to work with a Medusa commerce backend.

Core Ecommerce Features:

• Product Detail Page
• Product Overview Page
• Product Collections
• Cart management
• Checkout with Stripe
• User Accounts
• Order Details

Next.js 15 Capabilities:

• App Router
• Next fetching/caching
• Server Components
• Server Actions
• Streaming
• Static Pre-Rendering

This repository contains source code for various example projects built with Medusa v2. These examples demonstrate how to implement specific features, integrations, and storefront experiences using the Medusa platform.

To use a specific example, navigate to its directory and read its local README.md file for detailed setup and usage instructions.

The Invoice Generator example provides the following capabilities:

• Automatic Invoice Generation: Generates PDF invoices automatically upon order placement.
• Email Delivery: Automatically emails invoices to customers (requires a Notification Module Provider to be installed).
• Admin Dashboard: Provides UI for managing invoice configurations and downloading invoices.
• Store Customizations: Includes API routes for downloading invoices directly from the storefront.

You can view the full API specification via this OpenAPI Spec file to import into tools like Postman.

Medusa is an open-source set of commerce modules and tools designed to provide foundational commerce primitives. It allows developers to build ecommerce stores, marketplaces, and other commerce-driven applications without implementing core logic from scratch. All modules are available via npm.

Key architectural concepts include:

• Commerce Modules: Specialized modules that handle core commerce logic.
• Architecture: A modular system designed for customization and performance.

For deep dives, refer to the Medusa Architecture and Commerce Modules documentation.

You can extend the Medusa Admin dashboard by adding custom widgets and new pages. These customizations allow you to provide merchants with additional functionalities by interacting with your application's API routes.

To implement these, you typically create React components and register them within the admin directory structure.

Before setting up the Sanity integration, ensure you have the following:

• Node.js: v20 or higher
• Git CLI
• PostgreSQL
• Sanity Project: A configured project at sanity.io.
• CORS Configuration: You must add http://localhost:8000 to your Sanity project's CORS settings to allow requests from the local development environment.

To use a module within the Medusa application (such as in API routes or workflows), you must resolve the module service from the Medusa container using its exported module name.

Use req.scope.resolve(MODULE_NAME) where MODULE_NAME is the string constant exported by your module's index.ts.

import { BLOG_MODULE } from "../../../modules/blog"

// Inside an API route handler
const blogModuleService = req.scope.resolve(BLOG_MODULE)
const posts = await blogModuleService.listPosts()

A module link creates an association between two data models belonging to different modules while preserving module isolation. This allows you to relate entities (like a product from the Product Module and a post from a custom Blog Module) without tightly coupling the modules themselves.

To define a link, use the defineLink utility from @medusajs/framework/utils. You pass the linkable data models from each respective module as arguments.

After defining your links in code, you must synchronize them with your database by running the Medusa migration command.

import BlogModule from "../modules/blog"
import ProductModule from "@medusajs/medusa/product"
import { defineLink } from "@medusajs/framework/utils"

export default defineLink(
  ProductModule.linkable.product,
  BlogModule.linkable.post
)