README

oocscommerce/magento2-lynx-community

Lynx is a storefront for Magento 2: a Vue 3 single-page frontend driven by Inertia.js, with a visual page builder in the admin. Pages are built from components the merchant drags into place; each component gets its data from a PHP provider, so Magento's catalog, cart, checkout and account logic stay as they are.

This metapackage installs the core modules and themes.

Requirements

Magento Open Source 2.4
PHP 8.2+
Node.js 22.12+ and npm where the themes are built

Installation

composer require oocscommerce/magento2-lynx-community
bin/magento setup:upgrade
bin/magento lynx:theme:setup OOCS_LynxVue
bin/magento lynx:static:deploy
bin/magento setup:static-content:deploy

Then assign Lynx Vue in Content > Design > Configuration. See Installation for production builds and store configuration.

Packages

Package
`oocscommerce/module-lynx-catalog`	Category, search, product and compare pages for the Lynx storefront.
`oocscommerce/module-lynx-checkout`	The Lynx one-page checkout, together with the cart, success and failure pages.
`oocscommerce/module-lynx-checkout-agreements`	Terms and Conditions from Magento_CheckoutAgreements on the Lynx checkout and PayPal review pages.
`oocscommerce/module-lynx-cms`	CMS pages on the Lynx storefront, built in the page builder.
`oocscommerce/module-lynx-compiler`	Snapshots Magento's merged module XML so requests stop merging it.
`oocscommerce/module-lynx-component`	The component system the Lynx storefront is made of; it does not depend on the page builder.
`oocscommerce/module-lynx-customer`	The customer account and sign-in pages of the Lynx storefront.
`oocscommerce/module-lynx-customer-address`	Address form fields of the Lynx storefront, managed in the admin.
`oocscommerce/module-lynx-gift-message`	Gift messages from Magento_GiftMessage in the Lynx cart and on the order page.
`oocscommerce/module-lynx-google-tag`	Google Analytics 4 for the Lynx storefront.
`oocscommerce/module-lynx-inertia`	The server side of the Lynx storefront: pages are sent as Inertia.js responses.
`oocscommerce/module-lynx-mcp`	An MCP server that lets AI assistants build and edit Lynx store pages.
`oocscommerce/module-lynx-msi`	Multi-Source Inventory for the Lynx storefront.
`oocscommerce/module-lynx-new-relic`	New Relic Browser monitoring on Lynx store views.
`oocscommerce/module-lynx-optimize`	Cuts work Magento does on every request that the Lynx storefront does not use.
`oocscommerce/module-lynx-page-builder`	The visual editor for the Lynx storefront.
`oocscommerce/module-lynx-payment-paypal`	PayPal Express Checkout on the Lynx storefront.
`oocscommerce/module-lynx-product-alert`	Price and stock alerts from Magento_ProductAlert on the Lynx storefront.
`oocscommerce/module-lynx-re-captcha`	Google reCAPTCHA on Lynx storefront forms.
`oocscommerce/module-lynx-theme`	The foundation of the Lynx storefront: page shell, theme build and theme settings.
`oocscommerce/module-lynx-theme-component`	The default set of page builder components for the Lynx storefront.
`oocscommerce/theme-frontend-lynx-blank`	The base theme of Lynx: page shell templates without a frontend build.
`oocscommerce/theme-frontend-lynx-vue`	The Vue 3 storefront theme of Lynx, styled with Tailwind CSS 4 and daisyUI 5.

Add-ons, installed separately:

Package
`oocscommerce/module-lynx-payment-braintree`	Braintree payment methods on the Lynx checkout.
`oocscommerce/module-lynx-payment-stripe`	Stripe payment methods on the Lynx checkout.

Claude Code skills

The Lynx skills teach Claude Code to build on Lynx: components and their settings, PHP providers, pages, account tabs, payment and shipping methods, checkout steps, product types, child themes, server-side rendering, tests, porting Luma extensions and MCP tools. Ask for the result, such as "add a Lynx payment renderer for my method vendor_invoice", and it writes the module the way the developer guide describes. In Claude Code, run:

/plugin install lynx --marketplace oocscommerce/claude-skills

Documentation

https://docs.oocscommerce.com/lynx/

Community

Questions, ideas and help: join Lynx on Slack.

License

OSL-3.0 or AFL-3.0.

oocscommerce / magento2-lynx-community

Package info

Security

Statistics