Payload CMS for E-commerce

Key Features

• TypeScript-generated APIs with full type safety for product schemas and collection definitions
• MongoDB aggregation pipeline integration for complex product filtering and analytics
• Built-in admin panel with customizable field types for managing product variants and pricing
• Automatic REST and GraphQL endpoint generation from collection schemas
• Rich media handling with image optimization and variant generation for product galleries
• MongoDB change streams support for real-time inventory updates and webhooks
• Flexible access control with role-based permissions for multi-vendor scenarios
• Plugin architecture allowing custom field types and e-commerce workflow extensions

Common Use Cases

• 1Multi-vendor marketplaces requiring complex product categorization and vendor management
• 2Fashion e-commerce sites with size matrices, color variants, and seasonal inventory
• 3B2B catalogs with customer-specific pricing and bulk order management
• 4Digital product stores selling software licenses, courses, or downloadable content
• 5Subscription box services with recurring product rotations and member preferences
• 6Custom e-commerce solutions for industries with specialized product attributes
• 7Headless storefronts powered by React, Vue, or mobile applications

Prerequisites

• Node.js 18+ and npm/yarn for Payload CMS application development
• Minimum 2GB RAM for MongoDB operations with product collections and indexing
• Port 3000 available for Payload admin interface and API endpoints
• TypeScript knowledge for customizing collection schemas and field definitions
• Understanding of MongoDB document structure for optimizing product queries
• Familiarity with headless CMS concepts and API-driven content management

docker-compose.yml

1services: 
2  payload: 
3    image: node:20-alpine
4    container_name: payload
5    restart: unless-stopped
6    working_dir: /app
7    command: npm start
8    environment: 
9      MONGODB_URI: mongodb://mongodb:27017/${DB_NAME}
10      PAYLOAD_SECRET: ${PAYLOAD_SECRET}
11    volumes: 
12      - ./payload-app:/app
13    ports: 
14      - "3000:3000"
15    depends_on: 
16      - mongodb
17    networks: 
18      - payload
19
20  mongodb: 
21    image: mongo:6
22    container_name: payload-mongodb
23    volumes: 
24      - mongodb_data:/data/db
25    networks: 
26      - payload
27
28volumes: 
29  mongodb_data: 
30
31networks: 
32  payload: 
33    driver: bridge

.env Template

1DB_NAME=payload
2PAYLOAD_SECRET=your-secret-key

Usage Notes

Individual Services(2 services)

Copy individual services to mix and match with your existing compose files.

payload:
  image: node:20-alpine
  container_name: payload
  restart: unless-stopped
  working_dir: /app
  command: npm start
  environment:
    MONGODB_URI: mongodb://mongodb:27017/${DB_NAME}
    PAYLOAD_SECRET: ${PAYLOAD_SECRET}
  volumes:
    - ./payload-app:/app
  ports:
    - "3000:3000"
  depends_on:
    - mongodb
  networks:
    - payload

mongodb:
  image: mongo:6
  container_name: payload-mongodb
  volumes:
    - mongodb_data:/data/db
  networks:
    - payload

Quick Start

1# 1. Create the compose file
2cat > docker-compose.yml << 'EOF'
3services:
4  payload:
5    image: node:20-alpine
6    container_name: payload
7    restart: unless-stopped
8    working_dir: /app
9    command: npm start
10    environment:
11      MONGODB_URI: mongodb://mongodb:27017/${DB_NAME}
12      PAYLOAD_SECRET: ${PAYLOAD_SECRET}
13    volumes:
14      - ./payload-app:/app
15    ports:
16      - "3000:3000"
17    depends_on:
18      - mongodb
19    networks:
20      - payload
21
22  mongodb:
23    image: mongo:6
24    container_name: payload-mongodb
25    volumes:
26      - mongodb_data:/data/db
27    networks:
28      - payload
29
30volumes:
31  mongodb_data:
32
33networks:
34  payload:
35    driver: bridge
36EOF
37
38# 2. Create the .env file
39cat > .env << 'EOF'
40DB_NAME=payload
41PAYLOAD_SECRET=your-secret-key
42EOF
43
44# 3. Start the services
45docker compose up -d
46
47# 4. View logs
48docker compose logs -f

One-Liner

Run this command to download and set up the recipe in one step:

1curl -fsSL https://docker.recipes/api/recipes/payload-commerce/run | bash

Troubleshooting