Installation

Getting Started

Prerequisites

Before installing Metashop, please ensure that you have the latest version of pnpm, npm, or yarn installed on your system. You can install the latest version of pnpm, npm, or yarn by running the following command in your terminal:

pnpm Installation (Recommended)

npm install pnpm@latest -g

Installing Metashop is easy and straightforward. If you're using pnpm, simply run the following command in your terminal from the project root:

pnpm install

ℹ️

NOTE: Ensure that you have included all key-value pairs in the .env.local file located in the apps/site directory.

.env File Example

NEXT_PUBLIC_API_URL='https://mywpsite.example.com/'
NEXT_PUBLIC_SITE_URL='http://localhost:3000'
WOOCOMMERCE_CONSUMER_KEY=
WOOCOMMERCE_CONSUMER_SECRET=

💡

If you're using npm or yarn and you want to change the workspace setting in your package.json file, you can do so by modifying the following line: From: "ecommerce-ui": "workspace:* To: "ecommerce-ui": "*"

Required Wordpress plugins:

WooCommerce

CoCart – Headless ecommerce

Build

To build all apps and packages, run the following command:

cd my-project
pnpm run build

Develop

To develop all apps and packages, run the following command:

cd my-project
pnpm run dev

These commands will start a local development server and allow you to start developing your Metashop-powered e-commerce shop.

Thank you for choosing Metashop as your headless e-commerce theme! If you have any questions or issues, please contact our support team.

Introduction Deployment