Saltar al contenido
Guías

Instalación

Crea un storefront Ecomiq en minutos con create-ecomiq.

Última actualización:

Requisitos

  • Node.js 20 o superior
  • Una tienda Ecomiq activa (slug o dominio, p. ej. marketplace o tienda.pe)

Crea el proyecto

npm create ecomiq@latest

También puedes pasar el directorio:

npx create-ecomiq@latest my-store

El asistente te pedirá:

  1. Nombre del proyecto — carpeta destino
  2. Domain — slug o dominio de la tienda; se valida contra Storefront API antes de continuar
  3. Package manager — npm, pnpm, yarn o bun

Si el domain es válido, verás el nombre de la tienda y el scaffold continúa. Si no existe, te lo indica y puedes corregirlo.

El CLI descarga siempre el template scaffold (home, PLP, PDP, carrito, login y registro).

Arranca la tienda

cd my-store
npm run dev

Abre http://localhost:3000. La CLI genera .ecomiq/ (SSR + HMR); no la versiones:

.gitignore
.ecomiq/

Lo que obtienes:

ecomiq.config.js
package.json
layout.tsx

ecomiq.config.js ya incluye el domain que validaste. Sigue con configuración y la CLI.

Modo no interactivo

Útil en CI o scripts. Con --yes el --domain es obligatorio:

npx create-ecomiq@latest my-store \
  --domain marketplace \
  --pm pnpm \
  --yes
FlagDescripción
--domainDomain de la tienda (x-Store-Domain)
--pmnpm | pnpm | yarn | bun
--yes / -ySin prompts
--skip-installSolo escribe archivos; no ejecuta install

Instalación manual

Si prefieres montar el proyecto a mano (sin scaffold):

npm install @ecomiq/storefront react react-dom
npm install --save-dev typescript @types/node @types/react @types/react-dom

React 19, "type": "module" y scripts de la CLI:

package.json
{
  "private": true,
  "type": "module",
  "scripts": {
    "dev": "ecomiq dev",
    "build": "ecomiq build",
    "deploy": "ecomiq deploy",
    "clean": "ecomiq clean"
  }
}

Identifica la tienda en la raíz:

ecomiq.config.js
import { defineConfig } from "@ecomiq/storefront/config";

export default defineConfig({
  domain: "marketplace",
});

domain puede ser un slug (marketplace) o un dominio (marketplace.ecomiq.app / marketplace.pe).

Crea al menos una página:

pages/index.tsx
import { definePage } from "@ecomiq/storefront";

export default definePage({
  meta: () => ({ title: "Inicio" }),
  component: ({ settings }) => (
    <main>
      <h1>{settings.store.name}</h1>
      <p>{settings.store.description}</p>
    </main>
  ),
});

Luego npm run dev o pnpm dev.

Scaffold vs CLI

create-ecomiq crea el proyecto. La CLI ecomiq (incluida en @ecomiq/storefront) se usa después: dev, build, deploy y clean.

En esta página