📚 Docs | 🗣 Slack | 📝 Changelog

GraphCommerce is an open source front-end framework for building headless Magento e-commerce storefronts in React.

Take a look at the GraphCommerce demo store or set up your local development environment with the instructions below.

graphcommerce.mp4

---

Getting Started

Download the example

1. git clone git@github.com:graphcommerce-org/graphcommerce.git
2. mkdir my-project
3. cp -R graphcommerce/examples/magento-graphcms/. my-project
4. cd my-project
5. cp -R .env.example .env
6. rm CHANGELOG.md
7. rm -r node_modules && rm -r .next

Edit /package.json. Delete "scripts": {...} and rename scripts_local to scripts:

{
  "name": "@my-company/my-project",
  "scripts": {
    ...
  }
}

Start the development environment

• yarn Install the dependencies
• yarn codegen Converts all .graphql files to typescript files
• yarn dev Run the app

Visit the development environment running at http://localhost:3000
Visit the GraphQL Playground running at http://localhost:3000/api/graphql

Contributing to GraphCommerce

Learn how to contribute to GraphCommerce

---

Next steps

• Learn about the general concepts and file structure of the magento-graphcms example
• Learn more about getting started with GraphCommerce