@neverleans-labs/plug-store-core

Core engine of the PlugStore Framework — a turnkey headless catalog and e-commerce framework for React and Tailwind CSS.

Documentation · Live demo · Documentação em português

Installation

npm install @neverleans-labs/plug-store-core @neverleans-labs/plug-store-themes

Quick start

Render a complete storefront — routing, header, footer, product grid, cart, wishlist and search — with a single component:

import { CatalogApp } from '@neverleans-labs/plug-store-core';
import '@neverleans-labs/plug-store-core/dist/index.css';

export default function App() {
  return (
    <CatalogApp
      defaultTheme="fashion"
      config={{
        companyName: 'My Boutique',
        currency: 'BRL',
        whatsappPhone: '5511999999999',
        pixKey: '[email protected]', // enables a real, scannable Pix BR Code at checkout
        pixMerchantCity: 'Sao Paulo',
      }}
    />
  );
}

What's inside

• <CatalogApp /> — the full turnkey storefront, checkout included: a payment-method picker for WhatsApp, Pix and a demo card flow, no extra code.
• <CatalogProvider /> — bring your own layout, keep the state engine.
• Headless data providers — restDataProvider and customDataProvider connect to any REST, Supabase, Firebase, Prisma or GraphQL backend.
• useCheckout — the same checkout logic, headless: WhatsApp pre-filled orders, real Pix BR Codes (copy-paste and QR, EMV/Banco Central spec), Stripe and Mercado Pago.
• PWA and offline catalog — service worker caching with network-first fallbacks.
• SEO built in — JSON-LD Schema.org/Product, meta tags and Twitter cards.
• Zero-config analytics — automatic GA4 and Meta Pixel e-commerce events.

One extra step is easy to miss: Tailwind purges every PlugStore class unless your tailwind.config.js scans the compiled library.

content: [
  './src/**/*.{js,ts,jsx,tsx}',
  './node_modules/@neverleans-labs/plug-store-core/dist/**/*.js',
],

The Tailwind setup guide explains why. npm create plug-store writes this for you.

Peer dependencies

React and React DOM, ^18.0.0 || ^19.0.0, are required and are not bundled.

Documentation

| Topic | Page | |---|---| | Every export, with signatures | API reference | | Product, ShippingInfo, ThemeConfig, … | Types | | Store settings | Configuration | | Your own backend | Data & providers | | WhatsApp, Pix, Stripe, Mercado Pago | Checkout | | The 50 themes, live | Theme gallery |

License

Apache-2.0 © neverleans