Skip to main content
There are two ways of installing Mercur: the CLI script or manual installation.

​
Requirements

Node.js v20+ (LTS version only) Yarn installed Git CLI tool PostgreSQL installed and running

​
Install with the Mercur CLI

The Mercur CLI provides a guided setup and configures all required components automatically. Step 1: Install mercur-cli using NPM: 
npm i -g mercur-cli
Step 2: Run CLI installation: 
mercur-cli install
or 
npx mercur-cli install
The script will guide you through the installation process. You will have to enter project name and database connection parameters. Also, you’ll be asked if you want to install Mercur Storefront and Vendor panel. Step 3: After installation is done, move to the project catalog and start the servers: 
cd <yourProjectName>

mercur-cli dev
The script automatically configures environment variables, and runs seed. The default credentials for created users are: Vendor: 
email: seller@mercurjs.com
password: secret
Admin: 
email: admin@mercurjs.com
password: admin

​
Manual installation

Manual installation gives you full control over the Medusa and Mercur setup. Step 1: Create empty Medusa application using tool: 
npx create-medusa-app@latest my-medusa-store
Step 2: Install following dependencies: 
  @mercurjs/framework
  @mercurjs/b2c-core
  @mercurjs/commission
  @mercurjs/reviews
  @mercurjs/requests
  @mercurjs/algolia
  @mercurjs/resend
  @mercurjs/payment-stripe-connect
First two packages: @mercurjs/framework and @mercurjs/b2c-core are required, the rest of them are optional. We strongly recommend installing them all to avoid problems and missing features.
Step 3: Configure plugins in medusa-config.ts 
import { defineConfig, loadEnv } from '@medusajs/framework/utils'

loadEnv(process.env.NODE_ENV || 'development', process.cwd())

module.exports = defineConfig({
  projectConfig: {
    databaseUrl: process.env.DATABASE_URL,
    http: {
      storeCors: process.env.STORE_CORS!,
      adminCors: process.env.ADMIN_CORS!,
      // @ts-expect-error: vendorCors is not a valid config
      vendorCors: process.env.VENDOR_CORS!,
      authCors: process.env.AUTH_CORS!,
      jwtSecret: process.env.JWT_SECRET || 'supersecret',
      cookieSecret: process.env.COOKIE_SECRET || 'supersecret'
    }
  },
  plugins: [
    {
      resolve: '@mercurjs/b2c-core',
      options: {}
    },
    {
      resolve: '@mercurjs/commission',
      options: {}
    },
    {
      resolve: '@mercurjs/algolia',
      options: {
        apiKey: process.env.ALGOLIA_API_KEY,
        appId: process.env.ALGOLIA_APP_ID
      }
    },
    {
      resolve: '@mercurjs/reviews',
      options: {}
    },
    {
      resolve: '@mercurjs/requests',
      options: {}
    },
    {
      resolve: '@mercurjs/resend',
      options: {}
    }
  ],
  modules: [
    {
      resolve: '@medusajs/medusa/payment',
      options: {
        providers: [
          {
            resolve:
              '@mercurjs/payment-stripe-connect/providers/stripe-connect',
            id: 'stripe-connect',
            options: {
              apiKey: process.env.STRIPE_SECRET_API_KEY
            }
          }
        ]
      }
    },
    {
      resolve: '@medusajs/medusa/notification',
      options: {
        providers: [
          {
            resolve: '@mercurjs/resend/providers/resend',
            id: 'resend',
            options: {
              channels: ['email'],
              api_key: process.env.RESEND_API_KEY,
              from: process.env.RESEND_FROM_EMAIL
            }
          },
          {
            resolve: '@medusajs/medusa/notification-local',
            id: 'local',
            options: {
              channels: ['feed', 'seller_feed']
            }
          }
        ]
      }
    }
  ]
})
Step 4: Configure database credentials in the .env file 
# Replace user, password, address and port parameters with your values
DATABASE_URL=postgres://[user]:[password]@[address]:[port]/$DB_NAME
# For example:
DATABASE_URL=postgres://postgres:postgres@localhost:5432/$DB_NAME
Do not delete $DB_NAME from the connection string. You’ll be prompted to choose database name during the next step.
Step 5: Configure rest of your environment variables 
STRIPE_SECRET_API_KEY=
STRIPE_CONNECTED_ACCOUNTS_WEBHOOK_SECRET=

RESEND_API_KEY=
RESEND_FROM_EMAIL=

ALGOLIA_APP_ID=
ALGOLIA_API_KEY=

VITE_TALK_JS_APP_ID=
VITE_TALK_JS_SECRET_API_KEY=

STORE_CORS=
ADMIN_CORS=
VENDOR_CORS=

VENDOR_PANEL_URL=
STOREFRONT_URL=
BACKEND_URL=
Step 6: Setup database and run migrations 
yarn medusa db:create && yarn medusa db:migrate
Step 7: Create admin user 
npx medusa user --email <email> --password <password>
Step 8: Run application 
yarn dev

​
You’re ready to build

You now have a working Mercur marketplace environment.