# PlugStore A turnkey React and Tailwind CSS framework for product catalogs and online stores, built around Brazilian commerce: real Pix BR Codes to the Banco Central spec, WhatsApp orders, Mercado Pago. 50 industry themes, headless data providers, PWA and SEO included. Apache-2.0. Install: npm create plug-store Full text of every page below: https://neverleans.github.io/plug-store/llms-full.txt ## Start here - [What is PlugStore?](https://neverleans.github.io/plug-store/docs/intro/): An open-source React and Tailwind framework for product catalogs and online stores, with 50 industry themes, headless data providers, WhatsApp and Pix checkout, PWA and SEO built in. - [Built for Brazilian commerce](https://neverleans.github.io/plug-store/docs/brazil/): Pix, WhatsApp and Mercado Pago are checkout adapters that ship in the box and are covered by tests — not plugins you go looking for. What is inside, and exactly where it stops. - [How it works](https://neverleans.github.io/plug-store/docs/architecture/): How CatalogApp, CatalogProvider, the contexts and the data provider fit together, and where to plug your own code in. - [How this is maintained](https://neverleans.github.io/plug-store/docs/maintenance/): What "maintained" means here, as checks you can run yourself — including the gate that installs the packages the way you will, outside the workspace. ## Getting started - [Create a project](https://neverleans.github.io/plug-store/docs/getting-started/cli/): Scaffold a configured PlugStore project with the create-plug-store CLI, interactively or with flags. - [Add to an existing project](https://neverleans.github.io/plug-store/docs/getting-started/manual-install/): Install PlugStore into a React project you already have, with the exact imports and provider setup required. - [Tailwind setup](https://neverleans.github.io/plug-store/docs/getting-started/tailwind/): The Tailwind configuration PlugStore requires, why the content array must include the compiled package, and how to fix a store that renders unstyled. - [Deploy](https://neverleans.github.io/plug-store/docs/getting-started/deploy/): Deploying a PlugStore build to Vercel, Netlify, GitHub Pages or any static host — including the SPA rewrite and sub-directory hosting. ## Guides - [Store configuration](https://neverleans.github.io/plug-store/docs/guides/configuration/): Every option in CatalogConfig — store identity, currency, WhatsApp, Pix, social links and analytics — and how runtime configuration overrides it. - [Themes](https://neverleans.github.io/plug-store/docs/guides/themes/): Pick one of the 50 built-in industry themes, or build your client's brand with defineTheme — every colour token, font and layout style explained. - [Data providers](https://neverleans.github.io/plug-store/docs/guides/data/): Connect PlugStore to your own REST API, Supabase, Firebase, Prisma or GraphQL backend by implementing five async functions. - [Checkout](https://neverleans.github.io/plug-store/docs/guides/checkout/): The built-in checkout, the useCheckout hook, and how to plug in Stripe, Mercado Pago or any other payment provider through the adapter interface. - [Pix payments](https://neverleans.github.io/plug-store/docs/guides/pix/): How PlugStore builds a real, spec-compliant static Pix BR Code — the EMV payload, the CRC-16 checksum, the field limits, and what static Pix cannot do. - [Cart, wishlist and comparison](https://neverleans.github.io/plug-store/docs/guides/cart-wishlist/): The useCart, useWishlist, useCompare and useRecentlyViewed hooks — their full API, how totals are computed, and where the state is persisted. - [Language and currency](https://neverleans.github.io/plug-store/docs/guides/i18n-currency/): Switching the interface between Portuguese and English, formatting money for BRL, USD and EUR, and why PlugStore never converts prices. - [PWA and offline](https://neverleans.github.io/plug-store/docs/guides/pwa/): Service worker registration, the offline banner, and how to trigger the native install prompt from your own UI. - [SEO and analytics](https://neverleans.github.io/plug-store/docs/guides/seo-analytics/): JSON-LD product structured data, OpenGraph and Twitter cards, and zero-config GA4 and Meta Pixel e-commerce events. - [Admin panel](https://neverleans.github.io/plug-store/docs/guides/admin/): The built-in /admin route — what it can change, how CSV import and export work, and why it is not a substitute for a real backoffice. ## Recipes - [Connect a REST API](https://neverleans.github.io/plug-store/docs/recipes/rest-api/): A complete walkthrough of pointing PlugStore at your own REST backend, including the response shapes and how to adapt a schema that does not match. - [Connect Supabase](https://neverleans.github.io/plug-store/docs/recipes/supabase/): Table schema, row-level security policies and the data provider for running a PlugStore storefront on Supabase. - [Build a custom checkout](https://neverleans.github.io/plug-store/docs/recipes/custom-checkout/): Replace the built-in checkout page with your own form and payment provider, using useCheckout and a custom payment adapter. - [Build a client brand theme](https://neverleans.github.io/plug-store/docs/recipes/brand-theme/): Turning a client's brand guidelines into a PlugStore theme — converting hex to HSL channels, loading fonts, and checking contrast. ## Themes - [Theme gallery](https://neverleans.github.io/plug-store/docs/themes/gallery/): Every built-in PlugStore theme with a live preview, its id, hero style and card style. Click any theme to open it as a full storefront. ## Reference - [API reference](https://neverleans.github.io/plug-store/docs/reference/exports/): Every value exported by the PlugStore packages, with signatures and links to the guide that explains each one. - [Types](https://neverleans.github.io/plug-store/docs/reference/types/): Every exported TypeScript type in PlugStore — Product, Category, CartItem, ShippingInfo, Order, ThemeConfig, CatalogConfig and the checkout types. - [CLI reference](https://neverleans.github.io/plug-store/docs/reference/cli/): Every flag accepted by create-plug-store, the files it generates, and its exit codes.