SDK de Storefront
Nuestro micro-framework de React para crear tiendas Ecomiq con rutas SSR, Storefront API, checkout y despliegue en cualquier cloud.
Última actualización:
@ecomiq/storefront es nuestro micro-framework para construir tiendas Ecomiq
con React. A partir de pages/, genera las rutas y el servidor SSR; sus loaders
y funciones de servidor consultan la Storefront API.
También incluye providers y hooks para leer la configuración, los menús y el carrito, además de flujos para checkout, autenticación, cuentas de cliente y páginas CMS.
La CLI se encarga del entorno local y el build de producción. Traemos baterías listas para Cloudflare Workers, pero puedes desplegar tu tienda en cualquier cloud: Vercel, Railway, AWS, Google Cloud, un VPS u otro host Node compatible.
Tú mantienes esta estructura:
La CLI genera .ecomiq/ con el router, el servidor SSR y la configuración de build.
No edites esa carpeta ni la incluyas en el control de versiones.
Qué incluye
- Rutas SSR generadas desde
pages/, con un layout global y parámetros por archivo. - Loaders y funciones de servidor que consultan Storefront API mediante
serverApi. - Providers y hooks para configuración, menús, carrito y autenticación.
- Flujos incluidos para checkout, páginas CMS y área de cuenta.
- Comandos para desarrollo, build, limpieza y despliegue (con destino listo para Cloudflare Workers; también usable en otros hosts).
Imports públicos
| Import | Úsalo para |
|---|---|
@ecomiq/storefront | Páginas, layout, datos, providers, hooks, tipos y autenticación. |
@ecomiq/storefront/config | defineConfig y los tipos de configuración completa. |
@ecomiq/storefront/ui | Button, Card, Badge, Skeleton, Separator y otras bases. |
@ecomiq/storefront/styles.css | Estilos del framework; la CLI ya los incluye automáticamente. |
Los imports @ecomiq/storefront/internal/* son para el código generado en
.ecomiq/. No los uses en una tienda.
Flujo básico
- Crea el proyecto con
create-ecomiq. - Revisa el
domainen configuración. - Personaliza páginas con
definePage. - Ejecuta
ecomiq dev. - Publica con
ecomiq deploy.
Una tienda por proyecto
domain identifica la tienda que consumirá el proyecto.
El nombre, SEO, moneda, menús y reglas de checkout llegan desde
Storefront API mediante
GET /v1/settings.