npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-storefront-magento2-connector

v1.0.4

Published

Magento 2 Connector

Downloads

29

Readme

Magento 2 Connector

The React Storefront headless ecommerce connector for Adobe Magento 2.

Main features:

  • Product listing pages (PLP)
  • Product detail pages (PDP)
  • Cart

This guide covers how to get up and running with the Magento 2 Connector. For information on connectors in general and how to write your own connector refer to the React Storefront Connectors documentation.

Requirements

You will need a Magento 2 (sometimes referred to as "M2") backend to try out the connector.

Running Locally

Create a new React Storefront app using version 8.14.0 or later:

npm create react-storefront my-m2-app

Next cd into your created application and install the Magento2 connector:

cd my-m2-app
npm install react-storefront-magento2-connector

Next configure the M2_CONFIG_HOST environment variable in .env file to point to your Magento2 backend. See .env.sample file as an example of adding env variable via dotenv. You can also check this guide to get more info about Node.js Environment Variables. For example, your .env file may look like:

LEGACY_BACKEND_DOMAIN=www.my-magento-site.com
LEGACY_BACKEND_HOST_HEADER=www.my-magento-site.com
M2_CONFIG_HOST=http://www.my-magento-site.com

Finally set the connector in your next.config.js file. By default this file is set to use the react-storefront/mock-connector as shown below:

module.exports = withReactStorefront({

  // ... Some code
  
  connector: 'react-storefront/mock-connector',

  // ... More code

Change this line to use the react-storefront-magento2-connector as shown below:

module.exports = withReactStorefront({

  // ... Some code
  
  connector: 'react-storefront-magento2-connector',

  // ... More code

Now you can run your project locally,

npm start

And then visit http://127.0.0.1:3000 in your browser.

Deploying to the Moovweb XDN

The front-end React Storefront can be hosted anywhere that supports Node and Express but it works great on the Moovweb XDN. You can try the XDN for free by signing up here. Once you have an account you can deploy it by running xdn deploy:

xdn deploy

Refer to the XDN deployment guide for more information.

Development

  • In 1st terminal window (this repo), run yalc publish & npm run watch
  • In 2nd terminal window, open RSF starter app (commercial branch)
  • Go to next.config.js and change connector field value to react-storefront-magento2-connector
  • Run yalc add react-storefront-connector
  • Run npm i
  • Run npm run start