Open Mercato

https://docs.openmercato.com
Admin
Open Mercato is a next-generation, AI-supportive ERP foundation framework that is modular,...
Tokens:205,689
Snippets:2,661
Trust Score:5.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Bootstrap and Start Development Server

Source: https://docs.openmercato.com/installation/standalone

Installs dependencies, builds packages, generates registries, runs migrations and seeding, then starts the development server.

```bash
yarn setup  

yarn dev  
```

--------------------------------

### Bootstrap and Start Development Server on Linux

Source: https://docs.openmercato.com/installation/standalone

Installs dependencies, builds packages, generates registries, runs migrations and seeding, and then starts the development server.

```bash
yarn setup  

then:  
yarn dev  
```

--------------------------------

### Quick Start Docker Development Setup

Source: https://docs.openmercato.com/installation/setup

Clones the repository, checks out the develop branch, optionally copies and customizes the environment file, and then builds and starts the full development stack using Docker Compose.

```bash
# Clone the repository  
git clone https://github.com/open-mercato/open-mercato.git  
cd open-mercato  
git checkout develop  

# (Optional) Copy and customize environment  
cp apps/mercato/.env.example apps/mercato/.env  

# Build and start the full dev stack  
docker compose -f docker-compose.fullapp.dev.yml up --build  
```

--------------------------------

### Post-Install Steps

Source: https://docs.openmercato.com/cli/module-add

Commands to run after installing a module to apply database migrations and start the development server.

```bash
yarn db:migrate
```

```bash
yarn dev
```

--------------------------------

### Start Documentation Development Server

Source: https://docs.openmercato.com/installation/prerequisites

Run this command from the monorepo root to start the documentation development server. Ensure you have the necessary dependencies installed.

```bash
yarn docs:dev
```

--------------------------------

### One-Time Setup Commands

Source: https://docs.openmercato.com/customization/standalone-app

Useful one-time setup commands for authentication and installing CLIs. Ensure GitHub CLI, Codex CLI, and Claude Code are installed if needed.

```bash
gh auth login

npm i -g @openai/codex

curl -fsSL https://claude.ai/install.sh | bash
```

--------------------------------

### Install PostgreSQL via Homebrew

Source: https://docs.openmercato.com/installation/standalone

Installs PostgreSQL 16 using Homebrew and starts the service. Also creates the 'open-mercato' database.

```bash
brew install postgresql@16  
brew services start postgresql@16  
createdb open-mercato  
```

--------------------------------

### Set Up and Run Standalone App

Source: https://docs.openmercato.com/customization/standalone-app

Steps to set up and run the standalone Open Mercato application after scaffolding. This includes copying environment variables, starting infrastructure, installing dependencies, initializing the app, and starting the development server.

```bash
cd my-store

# 1. Copy environment template and configure
cp .env.example .env
# Edit .env — set DATABASE_URL, JWT_SECRET, REDIS_URL at minimum

# 2. Start infrastructure
docker compose up -d

# 3. Install dependencies
yarn install

# 4. Bootstrap the app (generates modules, runs migrations, seeds data)
yarn initialize

# 5. Start the dev server
yarn dev
```

--------------------------------

### Start Workflow Example

Source: https://docs.openmercato.com/framework/workflows

Demonstrates how to start a new workflow instance using the API. This includes specifying the workflow ID, initial context, and a correlation key.

```APIDOC
## POST /api/workflows/instances

### Description
Starts a new workflow instance.

### Method
POST

### Endpoint
/api/workflows/instances

### Request Body
- **workflowId** (string) - Required - The ID of the workflow to start.
- **initialContext** (object) - Required - The initial context for the workflow.
  - **orderId** (string) - Required - The order ID associated with the workflow.
  - **amount** (number) - Required - The amount for the order.
  - **requesterEmail** (string) - Required - The email of the requester.
  - **approverEmail** (string) - Required - The email of the approver.
- **correlationKey** (string) - Required - A key to correlate workflow instances.

### Request Example
```json
{
  "workflowId": "purchase-approval-v1",
  "initialContext": {
    "orderId": "order-123",
    "amount": 100.50,
    "requesterEmail": "user@example.com",
    "approverEmail": "manager@example.com"
  },
  "correlationKey": "order-123"
}
```

### Response
#### Success Response (200)
- **instanceId** (string) - The ID of the newly created workflow instance.

#### Response Example
```json
{
  "instanceId": "workflow-instance-abc"
}
```
```

--------------------------------

### Monorepo Setup and Build Commands

Source: https://docs.openmercato.com/installation/setup

Run the standard monorepo setup commands, including installing dependencies, building packages, generating code, and initializing the project.

```bash
yarn install
yarn build:packages
yarn generate
yarn build:packages
yarn initialize
yarn dev
```

--------------------------------

### Setup Auth Module

Source: https://docs.openmercato.com/cli/overview

Use `mercato auth setup` to perform the setup procedure for the authentication module.

```bash
mercato auth setup
```

--------------------------------

### Manual Prerequisite Installation Commands

Source: https://docs.openmercato.com/installation/setup

Manually install prerequisites if not using the setup script. This includes enabling Corepack, preparing Yarn, and installing Visual Studio Build Tools and C++ Redistributable.

```powershell
corepack enable
corepack prepare yarn@stable --activate
winget install Microsoft.VisualStudio.2022.BuildTools
winget install Microsoft.VCRedist.2015+.x64
```

--------------------------------

### Set Up Quick Start Environment Variables

Source: https://docs.openmercato.com/api/overview

Define environment variables for the base URL, API key, and optional organization ID to facilitate immediate use of curl examples.

```bash
export BASE_URL="http://localhost:3000/api"

export API_KEY="<paste your API key secret here>"

export ORG_ID="<optional active organization id>"
```

--------------------------------

### Production Setup: Async Strategy

Source: https://docs.openmercato.com/cli/scheduler

Configures and starts the scheduler in async mode for production. This involves setting environment variables, syncing schedules, and starting workers separately.

```bash
export QUEUE_STRATEGY=async
export REDIS_URL=redis://localhost:6379

yarn mercato scheduler status

yarn mercato scheduler start

yarn mercato worker:start

yarn mercato queue status scheduler-execution
```

--------------------------------

### Clone Repository and Start Full Stack Docker Deployment

Source: https://docs.openmercato.com/installation/setup

Quick start guide for cloning the Open Mercato repository and launching the full stack using Docker Compose. Ensure your .env file is configured.

```bash
# Clone the repository  
git clone https://github.com/open-mercato/open-mercato.git  
cd open-mercato  

# Copy environment template  
cp apps/mercato/.env.example apps/mercato/.env  

# Edit apps/mercato/.env with your configuration (see next section)  

# Build and start all services  
docker compose -f docker-compose.fullapp.yml up --build  
```

--------------------------------

### Initialize Workspace with Options

Source: https://docs.openmercato.com/cli/init

Use this command to initialize a new Open Mercato workspace. Customize the setup using various flags such as specifying organization name, admin credentials, roles, and controlling example data generation. Ensure `DATABASE_URL` is set before execution.

```bash
yarn initialize [--org=<name>] [--email=<address>] [--password=<value>] [--roles=<csv>] [--skip-password-policy] [--no-examples] [--stresstest] [--lite] [-n <count>] [--count=<count>] [--reinstall|-r]
```

--------------------------------

### Run Classic Setup Flow

Source: https://docs.openmercato.com/customization/standalone-app

Executes the classic setup flow for standalone apps, providing raw terminal output instead of a splash screen during bootstrap. Use this if you prefer the older setup experience.

```bash
yarn setup:classic
```

--------------------------------

### Start Ephemeral Environment with Verbose Logs

Source: https://docs.openmercato.com/cli/test-ephemeral

Starts the ephemeral environment and displays detailed bootstrap and build logs. Useful for debugging setup issues.

```bash
yarn mercato test:ephemeral --verbose
```

--------------------------------

### Install Entities

Source: https://docs.openmercato.com/cli/overview

Use `mercato entities install` to install entities.

```bash
mercato entities install
```

--------------------------------

### Install Dependencies and Bootstrap

Source: https://docs.openmercato.com/installation/wsl2

Install project dependencies, build packages, generate scripts, and initialize the application, including migrations and seeding.

```bash
yarn install  

yarn build:packages  
yarn generate  
yarn build:packages   # second run required — compiles generated scripts  

yarn initialize  
```

--------------------------------

### Install WSL Utilities (wslu)

Source: https://docs.openmercato.com/installation/wsl2

Install the wslu package for utilities like wslview, which integrates with Windows applications. Verify the installation and test xdg-open.

```bash
sudo apt update  
sudo apt install wslu  
```

```bash
which wslview    # should print /usr/bin/wslview  
xdg-open https://example.com   # should open in your Windows default browser  
```

--------------------------------

### Configure Environment Variables for Docker Deployment

Source: https://docs.openmercato.com/installation/setup

Example of essential environment variables to configure in `apps/mercato/.env` before starting the Docker stack. Includes database, authentication, and application settings.

```dotenv
# Database (container uses these to initialize PostgreSQL)  
POSTGRES_USER=postgres  
POSTGRES_PASSWORD=postgres  
POSTGRES_DB=open-mercato  
DATABASE_URL=postgres://postgres:postgres@postgres:5432/open-mercato  

# Authentication (generate a strong secret for production)  
JWT_SECRET=your-secure-jwt-secret-change-me  

# Application  
APP_URL=http://localhost:3000  
NODE_ENV=development  

# Caching  
CACHE_REDIS_URL=redis://redis:6379  
CACHE_STRATEGY=redis  

# Search (optional but recommended)  
MEILISEARCH_HOST=http://meilisearch:7700  
MEILISEARCH_API_KEY=meilisearch-dev-key  
MEILISEARCH_MASTER_KEY=meilisearch-dev-key  

```

--------------------------------

### Install a Specific Preview Tag

Source: https://docs.openmercato.com/cli/module-add

Installs a module from a package using a specific version tag, such as 'preview'.

```bash
yarn mercato module add @open-mercato/test-package@preview
```

--------------------------------

### Install WSL2 and Ubuntu

Source: https://docs.openmercato.com/installation/wsl2

Enables WSL, installs the WSL2 kernel, sets it as default, and installs Ubuntu. Restart your machine after running this command.

```powershell
wsl --install
```

--------------------------------

### Install and Register an Official Module

Source: https://docs.openmercato.com/framework/modules/official-modules

Use this command to install a new official module and register it with your Open Mercato application. After installation, apply any new database migrations introduced by the module.

```bash
yarn mercato module add @open-mercato/<module-name>
yarn db:migrate
```

--------------------------------

### Install Dependencies and Bootstrap Monorepo

Source: https://docs.openmercato.com/installation/monorepo

Install project dependencies, build packages, generate code, and initialize the application.

```bash
yarn install  
  
yarn build:packages  
yarn generate  
yarn build:packages  
  
yarn initialize  
```

--------------------------------

### Install Git on Fedora/RHEL

Source: https://docs.openmercato.com/installation/monorepo

Installs Git on Fedora or RHEL-based Linux systems using dnf.

```bash
sudo dnf install -y git
```

--------------------------------

### Start Infrastructure Services with Docker

Source: https://docs.openmercato.com/installation/standalone

Starts the Docker containers for PostgreSQL, Redis, and Meilisearch defined in the docker-compose.yml file.

```bash
docker compose up -d  
```

--------------------------------

### Install and Register Official Module

Source: https://docs.openmercato.com/cli/overview

Use `mercato module add <packageSpec>` to install and register an official `@open-mercato/*` module package.

```bash
mercato module add <packageSpec>
```

--------------------------------

### Install and Configure Native PostgreSQL on Linux

Source: https://docs.openmercato.com/installation/standalone

Installs PostgreSQL and its contrib package on Debian/Ubuntu and creates the 'open-mercato' database.

```bash
# Debian / Ubuntu  
sudo apt install -y postgresql postgresql-contrib  
sudo -u postgres createdb open-mercato  
```

--------------------------------

### Install Git on Debian/Ubuntu

Source: https://docs.openmercato.com/installation/monorepo

Installs Git on Debian or Ubuntu-based Linux systems using apt.

```bash
sudo apt update && sudo apt install -y git
```

--------------------------------

### Unblock Setup Script

Source: https://docs.openmercato.com/installation/setup

If Windows shows a security warning for the script, unblock it using this command before running the setup script.

```powershell
Unblock-File .\scripts\setup-windows-dev.ps1
```

--------------------------------

### Install Workspace Dependencies

Source: https://docs.openmercato.com/installation/setup

Installs all necessary dependencies for the Open Mercato workspace. This command is run after starting Docker services.

```bash
yarn install
```

--------------------------------

### Create and Configure App on Linux

Source: https://docs.openmercato.com/installation/standalone

Scaffolds a new Open Mercato app, navigates into it, copies the environment example, and sets up essential environment variables.

```bash
npx create-mercato-app my-app  
cd my-app  
cp .env.example .env  

DATABASE_URL=postgres://postgres:postgres@localhost:5432/open-mercato  
JWT_SECRET=change-me-dev-secret  
REDIS_URL=redis://localhost:6379  
```

--------------------------------

### Example of Adding a User with Roles

Source: https://docs.openmercato.com/cli/auth-add-user

This example demonstrates how to add a user, dynamically fetching the organization ID and assigning 'admin' and 'employee' roles.

```bash
ORG_ID=$(yarn mercato auth list-orgs | awk 'NR==5 {print $1}')
yarn mercato auth add-user \
  --email manager@acme.dev \
  --password ChangeMe123 \
  --organizationId "$ORG_ID" \
  --roles admin,employee
```

--------------------------------

### Quick Start Deployment with Docker Compose

Source: https://docs.openmercato.com/installation/vps

Clones the Open Mercato repository, sets up the environment file, and starts the full application stack in detached mode.

```bash
git clone https://github.com/open-mercato/open-mercato.git

cd open-mercato

cp apps/mercato/.env.example apps/mercato/.env
# Edit apps/mercato/.env with your production values (see below)

docker compose -f docker-compose.fullapp.yml up --build -d
```

--------------------------------

### Start the Development Server

Source: https://docs.openmercato.com/installation/monorepo

Run the application in development mode. Access the backend at http://localhost:3000/backend.

```bash
yarn dev  
```

--------------------------------

### Default Role Feature Assignments

Source: https://docs.openmercato.com/framework/progress/overview

Configure default feature access for roles. This example shows how 'admin' roles get all 'progress.*' features, while 'employee' roles only get 'progress.view'.

```typescript
defaultRoleFeatures: {
  admin: ['progress.*'],
  employee: ['progress.view'],
}
```

--------------------------------

### Get Job Details API Endpoint

Source: https://docs.openmercato.com/framework/progress/overview

Example of an API request to retrieve the details of a specific job by its ID.

```http
GET /api/progress/jobs/:id  

```

--------------------------------

### Install Dependencies and Bootstrap Application

Source: https://docs.openmercato.com/installation/monorepo

Installs project dependencies, builds packages, generates necessary scripts, and initializes the application, including database migrations and seeding.

```bash
yarn install

yarn build:packages
yarn generate
yarn build:packages   # second run required — compiles generated scripts

yarn initialize
```

--------------------------------

### Install Dependencies and Bootstrap Project

Source: https://docs.openmercato.com/installation/monorepo

Install project dependencies, build packages, generate code, and initialize the project. Note that `yarn build:packages` must be run twice as indicated in the tip.

```bash
yarn install

yarn build:packages
yarn generate
yarn build:packages

yarn initialize
```

--------------------------------

### Basic API Route Handler

Source: https://docs.openmercato.com/framework/modules/routes-and-pages

Implement a basic API route handler at `src/modules/<module>/api/<path>/route.ts`. This example shows a GET request handler that uses dependency injection and a query engine.

```typescript
// packages/my-module/src/modules/my_module/api/todos/route.ts  

import { NextResponse } from 'next/server'
import { createRequestContainer } from '@/lib/di/container'
import { getAuthFromCookies } from '@/lib/auth/server'

export async function GET(request: Request) {
  try {
    const container = await createRequestContainer()
    const queryEngine = container.resolve<QueryEngine>('queryEngine')

    // Your logic here
    const todos = await queryEngine.find('todo', {
      // query options
    })

    return NextResponse.json({ items: todos, total: todos.length })
  } catch (error) {
    return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
  }
}
```

--------------------------------

### Recommended PowerShell Commands for Windows Setup

Source: https://docs.openmercato.com/installation/prerequisites

Execute these PowerShell commands for a recommended native Windows monorepo workflow, including enabling Corepack, preparing Yarn, and installing Visual Studio Build Tools and the Visual C++ Redistributable.

```powershell
corepack enable

corepack prepare yarn@stable --activate

winget install Microsoft.VisualStudio.2022.BuildTools

winget install Microsoft.VCRedist.2015+.x64
```

--------------------------------

### Copy Environment File

Source: https://docs.openmercato.com/installation/wsl2

Copy the example environment file to create a new environment file for configuration.

```bash
cp apps/mercato/.env.example apps/mercato/.env  
```

--------------------------------

### Install Git on macOS

Source: https://docs.openmercato.com/installation/standalone

Installs Git on macOS. Use this command if Git is not already installed.

```bash
xcode-select --install
```

--------------------------------

### Configure Environment Variables

Source: https://docs.openmercato.com/installation/standalone

Copies the example environment file and sets essential variables like DATABASE_URL, JWT_SECRET, and REDIS_URL.

```bash
cp .env.example .env  

DATABASE_URL=postgres://postgres:postgres@localhost:5432/open-mercato  
JWT_SECRET=change-me-dev-secret  
REDIS_URL=redis://localhost:6379  
```

--------------------------------

### Full App Bootstrap

Source: https://docs.openmercato.com/cli/overview

Use `yarn initialize` for a full application bootstrap, including an optional reinstall mode. This command wraps `mercato init`.

```bash
yarn initialize
```

--------------------------------

### Install Homebrew on macOS

Source: https://docs.openmercato.com/installation/standalone

Installs Homebrew package manager on macOS. This is a prerequisite for installing Node.js and PostgreSQL via Homebrew.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Start Docker Dev Stack with Wrapper

Source: https://docs.openmercato.com/installation/docker

Initiates the development stack using the provided yarn docker:dev:up command.

```bash
yarn docker:dev:up
```

--------------------------------

### Install Node.js using NVM

Source: https://docs.openmercato.com/installation/wsl2

Install Node Version Manager (nvm) and then use it to install, use, and set the default Node.js version to 24. This method installs Node.js into your user directory without requiring sudo.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash  
```

```bash
nvm install 24  
nvm use 24  
nvm alias default 24  
```

--------------------------------

### Create Backend Page Directory and Files

Source: https://docs.openmercato.com/customization/create-first-module

Use these commands to create the necessary directory structure and placeholder files for a new backend page.

```bash
mkdir -p apps/mercato/src/modules/inventory/backend/inventory  

touch apps/mercato/src/modules/inventory/backend/inventory/page.tsx  

touch apps/mercato/src/modules/inventory/backend/inventory/page.meta.ts  
```

--------------------------------

### Install Build Tools for Native Node Modules

Source: https://docs.openmercato.com/installation/wsl2

Run this before `yarn install` to ensure C/C++ toolchain and Python are available for compiling native Node modules. If `yarn install` was run previously, you may need to run `yarn rebuild` after installing these tools.

```bash
sudo apt update

sudo apt install -y build-essential python3
```

```bash
yarn rebuild
```

--------------------------------

### Install Node.js 24 via nvm

Source: https://docs.openmercato.com/installation/standalone

Installs Node.js version 24 using nvm (Node Version Manager). Ensure to reopen your terminal after installation.

```bash
# Or via nvm  

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash  
# Reopen terminal, then:  
nvm install 24 && nvm use 24 && nvm alias default 24  
```

--------------------------------

### Apply Database Migrations and Development

Source: https://docs.openmercato.com/installation/setup

For an existing database, apply new migrations, generate necessary files, and start the development server.

```bash
yarn db:migrate
yarn generate
yarn dev
```

--------------------------------

### Enable Installed Official Module

Source: https://docs.openmercato.com/cli/overview

Use `mercato module enable <packageName>` to register an already installed official module package without installing dependencies.

```bash
mercato module enable <packageName>
```

--------------------------------

### CLI Command to Seed Example Currencies

Source: https://docs.openmercato.com/framework/modules/currencies

Use this CLI command to populate the system with example currencies (USD, EUR, PLN, GBP) for testing purposes.

```bash
yarn mercato currencies seed
```

--------------------------------

### Start Ephemeral Environment for QA

Source: https://docs.openmercato.com/cli/overview

Use `yarn test:integration:ephemeral:start` to start only the disposable application and database containers for QA or MCP exploration.

```bash
yarn test:integration:ephemeral:start
```

--------------------------------

### Enable Example Injection Widgets

Source: https://docs.openmercato.com/framework/widget-injection

Set this environment variable to true to enable demo injection widgets. The default is false.

```bash
NEXT_PUBLIC_OM_EXAMPLE_INJECTION_WIDGETS_ENABLED=true
```

```bash
NEXT_PUBLIC_OM_EXAMPLE_INJECTION_WIDGETS_ENABLED=false
```

--------------------------------

### Safely Start Workflow with API Fetch

Source: https://docs.openmercato.com/framework/workflows/services

Handles potential API and network errors when starting a new workflow instance. Returns null if the workflow fails to start.

```typescript
import { apiFetch } from '@open-mercato/ui/backend/utils/api'

async function safeStartWorkflow(workflowId: string, context: any) {
  try {
    const response = await apiFetch('/api/workflows/instances', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ workflowId, initialContext: context })
    })
  
    if (!response.ok) {
      const error = await response.json()
      console.error('Workflow start failed:', error.message)
      return null
    }
  
    return await response.json()
  } catch (error) {
    console.error('Network error:', error)
    return null
  }
}
```

--------------------------------

### Install Node.js 24 via nvm on Linux

Source: https://docs.openmercato.com/installation/standalone

Installs Node.js version 24 using nvm (Node Version Manager) on Linux. Close and reopen the terminal after installation.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash  
# Close and reopen terminal, then:  
nvm install 24 && nvm use 24 && nvm alias default 24  
```

--------------------------------

### Copy Environment Template

Source: https://docs.openmercato.com/installation/setup

Copies the example environment file to be used for local development. Ensure required variables like DATABASE_URL, JWT_SECRET, and REDIS_URL are set.

```bash
cp apps/mercato/.env.example apps/mercato/.env
```

--------------------------------

### Install Node.js 24 via nvm

Source: https://docs.openmercato.com/installation/monorepo

Installs and configures Node.js version 24 using nvm (Node Version Manager). Ensure to close and reopen your terminal after installation.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

# Close and reopen your terminal, then:
nvm install 24
nvm use 24
nvm alias default 24
```

--------------------------------

### Install GitHub CLI from Ubuntu Package Mirror

Source: https://docs.openmercato.com/installation/wsl2

Installs the GitHub CLI using the standard Ubuntu package repository. This is the simplest method if the repository version is up-to-date.

```bash
sudo apt update && sudo apt install gh -y
```

--------------------------------

### Navigate to Open Mercato Develop Branch

Source: https://docs.openmercato.com/installation/setup

Ensure you are on the develop branch after cloning the repository. This is part of the recommended develop setup steps.

```bash
cd open-mercato

git checkout develop
```

--------------------------------

### Install Git on Fedora/RHEL

Source: https://docs.openmercato.com/installation/standalone

Installs Git on Fedora or RHEL-based Linux distributions.

```bash
# Fedora / RHEL  
sudo dnf install -y git  
```

--------------------------------

### Install Git on Debian/Ubuntu

Source: https://docs.openmercato.com/installation/standalone

Installs Git on Debian or Ubuntu-based Linux distributions.

```bash
# Debian / Ubuntu  
sudo apt update && sudo apt install -y git  
```

--------------------------------

### Start Scheduler Engine

Source: https://docs.openmercato.com/cli/scheduler

Starts the scheduler engine. Behavior differs based on QUEUE_STRATEGY: Local mode starts a polling engine, while Async mode performs a one-time sync with BullMQ and exits.

```bash
yarn mercato scheduler start
```

--------------------------------

### Start Docker Services

Source: https://docs.openmercato.com/installation/setup

Starts all services defined in the docker-compose.fullapp.yml file in detached mode.

```bash
docker compose -f docker-compose.fullapp.yml up -d
```

--------------------------------

### Stripe Webhook Setup

Source: https://docs.openmercato.com/api/payment-gateways

Instructions for setting up Stripe webhooks, including the endpoint URL and recommended events.

```APIDOC
### Stripe Webhook Setup

#### Endpoint URL
Configure Stripe to send webhooks to:
```
https://YOUR_APP_URL/api/payment_gateways/webhook/stripe
```
For local development with ngrok:
```
ngrok http 3000
```
Then use:
```
https://YOUR-NGROK-SUBDOMAIN.ngrok-free.app/api/payment_gateways/webhook/stripe
```

#### Recommended Stripe Events
Subscribe at minimum to:
```
payment_intent.succeeded
payment_intent.payment_failed
payment_intent.canceled
payment_intent.requires_action
charge.refunded
charge.refund.updated
charge.dispute.created
charge.dispute.closed
```

After creating the endpoint in **Stripe Dashboard - > Workbench -> Webhooks**, reveal the endpoint signing secret and paste the `whsec_...` value into the Stripe integration's **Webhook Signing Secret** field in Open Mercato.
```

--------------------------------

### Create Open Mercato App

Source: https://docs.openmercato.com/installation/standalone

Scaffolds a new standalone Open Mercato application named 'my-app' and navigates into the project directory.

```bash
npx create-mercato-app my-app  
cd my-app  
```

--------------------------------

### Cron Expression Examples

Source: https://docs.openmercato.com/framework/scheduler/overview

Examples of standard 5-field cron expressions for various scheduling needs.

```text
'0 0 * * *'      // Daily at midnight  
```

```text
'0 */6 * * *'    // Every 6 hours  
```

```text
'*/15 * * * *'   // Every 15 minutes  
```

```text
'0 9 * * 1-5'    // Weekdays at 9 AM  
```

```text
'0 0 1 * *'      // First day of month at midnight  
```

```text
'0 0 * * 0'      // Every Sunday at midnight  
```
Tokens:
Raw