Coder Social home page Coder Social logo

kman1131 / magento2-connector Goto Github PK

View Code? Open in Web Editor NEW

This project forked from storefront-foundation/magento2-connector

0.0 1.0 0.0 1.03 MB

A Magento 2 connector for React Storefront

License: Apache License 2.0

JavaScript 1.36% TypeScript 98.64%

magento2-connector's Introduction

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

magento2-connector's People

Contributors

dijs avatar ianand avatar markbrocato avatar traa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.