🛒 miniMerch Setup Guide

Prerequisites

Before setting up miniMerch, make sure you have:

• Minima installed - Follow the node setup guide for your platform
• Node synced - Your Minima node should be fully synced
• CoinMarketCap API key (optional) - For real-time Minima pricing

Step 1: Install the CLI Tool

miniMerch uses a command-line tool to generate your shops. You have two options:

Option A: Global Install (Quick Setup)

Install globally with npm. Use this if you just want to run miniMerch commands:

npm install -g @eurobuddha/mini-merch

After this, you can run commands like npx mini-merch setup...

Option B: Local Install (Full Source)

Clone the repository to your computer. Use this if you want the full source code:

1. Open Terminal (or Command Prompt on Windows)
2. Navigate to where you want to keep your files:

cd ~/Documents

3. Clone the miniMerch repository:

git clone https://github.com/eurobuddha/miniMerch.git

5. Go into the folder:

cd miniMerch

7. Install dependencies:

npm install

After this, run commands with node ./src/index.js

Step 2: Get Your Keys

You'll need three pieces of information:

Minima Address

Your address for receiving payments:

1. Open the Wallet MiniDapp
2. Click Receive
3. Copy one of your receive addresses. Use the address that's formatted starting with 0x, not Mx

Maxima mxpublickey

Your public key for encrypting orders. This must be obtained from the Terminal.

1. Open the Terminal MiniDapp in Minima
2. Type the following command:

maxima

3. Press Enter
4. Find the line that says "mxpublickey":
5. Copy the value - it starts with Mx and is a long string
6. Be accurate when copying.

CoinMarketCap API Key (Optional)

For accurate Minima pricing in your shop:

1. Visit coinmarketcap.com/api
2. Create a free account
3. Go to Dashboard → API Keys → Create Key
4. Copy your API key

If you skip this, miniMerch will use a default price.

Step 3: Run Setup Command

Configure your vendor details with this command:

node ./src/index.js setup <minima-address> <cmc-api-key> <mxpublickey>

Global Install:

npx mini-merch setup <minima-address> <cmc-api-key> <mxpublickey>

Local Install:

node ./src/index.js setup <minima-address> <cmc-api-key> <mxpublickey>

Example:

node ./src/index.js setup 0x465CA86A9B5756F45DEB667A69B3DBEC1B82B211 c1d37f5f89564ca58 MxG18HGG6FJ038614Y8CW46US6G20810K0070CD00Z83282G60G19TUFFWSB6EEF...

This saves your configuration locally. You only need to run this once.

Step 4: Generate Your Shop

miniMerch gives you two ways to generate a shop — a single-product shop or a multi-product shop with up to 40 items.

Option A: Single-Product Shop

Use this if you want a shop with one product. Pass all product details as command-line flags:

Global Install:

npx mini-merch generate -n "Product Name" -m units -p 25 -u 50

Local Install:

node ./src/index.js generate -n "Product Name" -m units -p 25 -u 50

Required Flags

Mode-Specific Flags

Optional Flags

Examples

Weight mode (selling by weight):

node ./src/index.js generate -n "Organic Barley" -m weight -p 5 -w 1000 -d "Premium malting barley"

Sells up to 1000g at $5/gram.

Units mode (selling fixed items):

node ./src/index.js generate -n "PDF Bundle" -m units -p 25 -u 50 -d "Collection of guides" --slippage 5

Sells 50 units at $25 each, with 5% Minima slippage buffer.

Option B: Multi-Product Shop (up to 40 items)

Use the interactive wizard to add up to 40 products to a single shop. The wizard prompts you for each product's details one by one, then generates everything in one go.

Global Install:

npx mini-merch generate-multi

Local Install:

node ./src/index.js generate-multi

The wizard will ask you for each product:

• Name — the product title
• Mode — weight or units (press Enter for weight)
• Price — in USD per gram or per unit
• Weight or units — maximum available
• Description — short product description (optional)
• Image path — local file path to the product image (optional)

After all products are entered, the wizard asks for a slippage % (the buffer added to the Minima price at checkout to cover volatility — default 10%). Then it builds both zip files automatically.

Leave the product name blank at any point to stop adding products and proceed to generation.

Step 5: Your Generated Files

After running either generate command, your files are created in a dist/ folder:

Step 6: Install MiniDapps on Your Node

As the vendor, you need to install the inbox MiniDapp on your node:

• miniMerchInbox.mds.zip - Installs on YOUR node to receive and manage orders

Note: The shop MiniDapp (miniMerch_YourProduct.mds.zip) is installed by your customers on their nodes to place orders.

Accessing the MiniDapp Hub

Option A: In Browser

If you're using macOS, Linux, or Windows:

1. Open your browser
2. Go to: https://127.0.0.1:9003
3. Log into the MiniDapp Hub

Option B: Desktop Connect (Android)

If you're using Android on your phone:

1. Open the Minima app on your phone
2. Go to Settings → Desktop Connect
3. Copy the URL and password shown
4. Open that URL in your computer's browser
5. Enter the password to log in

Installing the Inbox

Install the inbox from your dist/ folder:

1. In the MiniDapp Hub, click the + (plus) button
2. Navigate to your dist/ folder
3. Select miniMerchInbox.mds.zip
4. Your inbox is now installed and ready to receive orders

Managing Your MiniDapps

Updating a MiniDapp

1. Right-click on the miniMerch Inbox
2. Select "Update"
3. Select the new .mds.zip file

Deleting a MiniDapp

1. Right-click (or long-press on mobile) on the MiniDapp
2. Select "Delete MiniDapp"
3. Confirm the deletion

Distributing Your Shop

Once you have your shop file, there are several ways to reach customers:

Via Email

Send the shop file directly to your customer list:

1. Find your shop file in the dist/ folder
2. Attach it to an email or send via a file sharing service
3. Customers install it on their Minima node to place orders

Via Your Website

Host the shop file on your existing website:

1. Upload miniMerch_YourProduct.mds.zip to your web host
2. Link to it from your product page
3. Add a link to these instructions for your new users

Via Existing Marketplaces

Link to your Minima shop from your existing sales channels to avoid platform fees:

• Etsy - Link to your Minima shop in your product description or shop banner
• eBay - Include your Minima shop link in item listings or your seller page
• Facebook Marketplace - Share your shop file in posts or groups
• Instagram/TikTok - Bio links or pinned posts directing to your shop

Via IPFS (Advanced)

For decentralized hosting:

1. Upload your shop file to IPFS using Pinata, nft.storage, or similar
2. Share the IPFS link with customers
3. The link will always work as long as someone pins your file

CLI Commands Reference

Global Install Commands

# One-time setup
npx mini-merch setup <address> <cmc-key> <mxpublickey>

# Generate single-product shop (weight mode)
npx mini-merch generate -n "Product" -m weight -p 5 -w 500

# Generate single-product shop (units mode)
npx mini-merch generate -n "Product" -m units -p 25 -u 50

# Generate single-product shop with custom slippage
npx mini-merch generate -n "Product" -m units -p 25 -u 50 --slippage 5

# Generate multi-product shop (interactive wizard, up to 40 products)
npx mini-merch generate-multi

# Open miniMerch Studio web UI (visual shop builder)
npx mini-merch studio

# View config
npx mini-merch config --show

# Reset config
npx mini-merch config --reset

# Help
npx mini-merch --help

Local Install Commands

Run these from the miniMerch folder:

# One-time setup
node ./src/index.js setup <address> <cmc-key> <mxpublickey>

# Generate single-product shop (weight mode)
node ./src/index.js generate -n "Product" -m weight -p 5 -w 500

# Generate single-product shop (units mode)
node ./src/index.js generate -n "Product" -m units -p 25 -u 50

# Generate single-product shop with custom slippage
node ./src/index.js generate -n "Product" -m units -p 25 -u 50 --slippage 5

# Generate multi-product shop (interactive wizard, up to 40 products)
node ./src/index.js generate-multi

# Open miniMerch Studio web UI (visual shop builder)
node ./src/index.js studio

# View config
node ./src/index.js config --show

# Reset config
node ./src/index.js config --reset

# Help
node ./src/index.js --help

Troubleshooting

"Command not found" error

Make sure npm global bin directory is in your PATH. On macOS/Linux, add to your shell config:

export PATH="$PATH:$(npm bin -g)"

Can't access MiniDapp Hub

• Make sure your Minima node is running
• For local access: go to https://127.0.0.1:9003
• For Desktop Connect: check Settings on your phone

Need help?

• Join the Minima Discord
• Check the miniMerch GitHub

Next Steps