PHPackages                             softcommerce/module-graphcommerce-cms - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. softcommerce/module-graphcommerce-cms

ActiveMagento2-module[API Development](/categories/api)

softcommerce/module-graphcommerce-cms
=====================================

Magento GraphCommerce CMS.

1.0.5(1y ago)41573[2 issues](https://github.com/softcommerceltd/magento-graphcommerce-cms/issues)1OSL-3.0PHPPHP ~8.0.0||~8.1.0||~8.2.0||~8.3.0

Since May 3Pushed 1y ago4 watchersCompare

[ Source](https://github.com/softcommerceltd/magento-graphcommerce-cms)[ Packagist](https://packagist.org/packages/softcommerce/module-graphcommerce-cms)[ RSS](/packages/softcommerce-module-graphcommerce-cms/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (4)Versions (7)Used By (1)

GraphCommerce headless CMS extension for Magento 2
==================================================

[](#graphcommerce-headless-cms-extension-for-magento-2)

The core purpose of this module is to provide integration of PageBuilder Content Management System for [GraphCommerce® headless theme](https://www.graphcommerce.org/), eventually replacing original HyGraph with its own CMS. This module extends PageBuilder's functionality by introducing custom components that are used for building page content.

Features
--------

[](#features)

- Build rich page content by using Magento's native PageBuilder;
- Create media asset elements that support both images, SVG and video formats;
- CMS Pages, Blocks, Widgets, Categories and Products are supported;
- Add your own custom PageBuilder components;

Supported PageBuilder Components
--------------------------------

[](#supported-pagebuilder-components)

- Use `cmsRowHeroBanner` component to build elements with banner elements;
- Use `CmsRowLinks` component to build link elements that support linking to categories, products and custom URL paths.
- Use `CmsRowProduct` component to build catalog elements with ability to specify products by either category, SKU or custom rules;
- Use `CmsRowSpecialBanner` component to build banner content elements;
- Use `CmsRowQuote` component to build rich text quotes;
- Use `CmsRowText` component to build rich text content;
- Use `CmsRowServiceLinks` component to build service links with the support of MUI icons;

Supported PageBuilder Elements
------------------------------

[](#supported-pagebuilder-elements)

- `gc-asset` - used to serve images and video files;
- `gc-heading` - used to provide a heading for components that require titles.
- `gc-page-links` - used to provide links that support either a direct, product, category or CMS page URL;
- `gc-products` - used to provide product listing defined by either a category, SKUs or a custom rule;
- `gc-richtext` - used to provide content built with the wysiwyg as an AST format;

Compatibility
-------------

[](#compatibility)

- Open Source >= 2.4.4

Demo
----

[](#demo)

Magento Extension Installation
------------------------------

[](#magento-extension-installation)

Using composer

```
# GH source: https://github.com/softcommerceltd/magento-graphcommerce-cms
composer require softcommerce/module-graphcommerce-cms
```

Post Installation
-----------------

[](#post-installation)

```
# Enable the module
bin/magento module:enable SoftCommerce_GraphCommerceCms
bin/magento setup:upgrade
```

In production mode:

```
# compile & generate static files
bin/magento deploy:mode:set production
```

In development mode:

```
bin/magento setup:di:compile

```

GraphCommerce Node Package Installation
---------------------------------------

[](#graphcommerce-node-package-installation)

Using YARN \[recommended\]

```
# GH source: https://github.com/softcommerceltd/graphcommerce-magento-cms
yarn add @softcommerce/graphcommerce-magento-cms
```

Using NPM

```
# GH source: https://github.com/softcommerceltd/graphcommerce-magento-cms
npm install @softcommerce/graphcommerce-magento-cms
```

Magento Demo \[sample\] Project Installation
--------------------------------------------

[](#magento-demo-sample-project-installation)

Install latest magento instance

```
# Install Magento
# Source: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/composer
composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition magento.graphcommerce
```

Create DB & USER (replace credentials & password as required)

```
CREATE DATABASE magento_graphcommerce;
CREATE USER 'magento_graphcommerce'@'localhost' IDENTIFIED BY 'magento.graphcommerce.pwd';
GRANT ALL PRIVILEGES ON magento_graphcommerce.* TO 'magento_graphcommerce'@'localhost';
GRANT SUPER ON *.* TO magento_graphcommerce@'localhost';
GRANT PROCESS ON *.* TO magento_graphcommerce@localhost;
FLUSH PRIVILEGES;

```

Install magento application

```
# Install Magento
# Replace opensearch with elasticsearch if the latter one installed.
# Replace user credentials if required.
# Source: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/composer
bin/magento setup:install \
--base-url=https://magento.graphcommerce/ \
--db-host=localhost \
--db-name=magento_graphcommerce \
--db-user=magento_graphcommerce \
--db-password=magento.graphcommerce.pwd \
--admin-firstname=Magento \
--admin-lastname=GraphCommerce \
--admin-email=magento-gc@example.com \
--admin-user=magento.graphcommerce \
--admin-password=magento.graphcommerce.pwd \
--language=en_GB \
--currency=GBP \
--timezone=Europe/London \
--use-rewrites=1 \
--search-engine=opensearch \
--opensearch-host=localhost \
--opensearch-index-prefix=magento.graphcommerce \
--opensearch-port=9200
```

Install sample data

```
# Install Magento sample data
# Source https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/next-steps/sample-data/composer-packages
bin/magento deploy:mode:set developer
bin/magento sampledata:deploy
# Install GraphCommerce sample data
# GH Source:
# https://github.com/softcommerceltd/magento-graphcommerce-cms-sample-data
# https://github.com/softcommerceltd/magento-graphcommerce-cms-sample-data-media
composer require softcommerce/module-graphcommerce-cms-sample-data
# Update the application
bin/magento setup:upgrade
```

Set the application to production

```
# Compile the application code
# and generate static files for production environment
bin/magento deploy:mode:set production
# Run indexing
bin/magento indexer:reindex
```

\*\*\* Note: SSL certificate is required. Use free one from

GraphCommerce PWA Demo Project
------------------------------

[](#graphcommerce-pwa-demo-project)

Both Magento & GraphCommerce plugins require some modifications to GC React project pages. Use the demo below as a starting point for your project.

```
# Clone demo project
# GH Source: https://github.com/softcommerceltd/magento-graphcommerce-pwa
git clone -b main --single-branch git@github.com:softcommerceltd/magento-graphcommerce-pwa.git
```

- Edit graphcommerce.config.js file to change the canonical and endpoint URLs as required.
- Edit next.config.js file to change images hostname configuration.

License
-------

[](#license)

[Open Software License (OSL 3.0)](https://opensource.org/licenses/osl-3.0.php). Please see `LICENSE.txt` for full details of the OSL 3.0 license.

Thanks for dropping by
----------------------

[](#thanks-for-dropping-by)

 [ ![Soft Commerce Ltd](https://camo.githubusercontent.com/05726a030bab5a49fa0520196d901e5ec9f4d8b9e43142e49e50f0cb0c47b0a4/68747470733a2f2f736f6674636f6d6d657263652e636f2e756b2f7075622f6d656469612f62616e6e65722f6c6f676f2e737667) ](https://softcommerce.io)
 [https://softcommerce.io/](https://softcommerce.io)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance21

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~8 days

Total

6

Last Release

705d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/612c19aab21c48e9c7d11d11eab8863b9473743c6ab7335aeb5a1424129b46cc?d=identicon)[softcom](/maintainers/softcom)

---

Top Contributors

[![softcommerceltd](https://avatars.githubusercontent.com/u/6104757?v=4)](https://github.com/softcommerceltd "softcommerceltd (14 commits)")

### Embed Badge

![Health badge](/badges/softcommerce-module-graphcommerce-cms/health.svg)

```
[![Health](https://phpackages.com/badges/softcommerce-module-graphcommerce-cms/health.svg)](https://phpackages.com/packages/softcommerce-module-graphcommerce-cms)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)