diff --git a/.changeset/neat-timers-unite.md b/.changeset/neat-timers-unite.md new file mode 100644 index 0000000000..9633706228 --- /dev/null +++ b/.changeset/neat-timers-unite.md @@ -0,0 +1,6 @@ +--- +'@graphcommerce/docs': patch +'@graphcommerce/service-worker': patch +--- + +Moved to serwist for service workers diff --git a/docs/getting-started/create.md b/docs/getting-started/create.md index 1130faa112..4744875624 100644 --- a/docs/getting-started/create.md +++ b/docs/getting-started/create.md @@ -8,10 +8,10 @@ metaTitle: Getting started with GraphCommerce In this guide, you will set up a GraphCommerce app locally, allowing you to start building. -### Requirements +### Preparations -- Lixux, MacOS or WSL2 -- Install and use node 16/18: `nvm install 16` or `nvm use 16` +- MacOS, Windows with WSL2 or Linux +- Install and use node 20: `nvm install 20` or `nvm use 20` - Install yarn: `corepack enable` ## Step 1: Create a GraphCommerce app @@ -26,19 +26,34 @@ mkdir my-project # Create project folder ``` +There are a few starting points to choose from with or without Hygraph: + +Option 1: Only Magento Open Source: + ```bash -cp -R graphcommerce/examples/magento-graphcms/. my-project && rm -rf graphcommerce && cd my-project -# Copy example, delete repo, navigate to project folder +cp -R graphcommerce/examples/magento-magento-open-source/. my-project && cd my-project ``` +Option 2: Magento Open Source + Hygraph: + +```bash +cp -R graphcommerce/examples/magento-graphcms/. my-project && cd my-project +``` + +Option 3: Adobe Commerce: + +Please contact us for more information to get access to the Adobe Commerce +starting point. + ## Step 2: Configure API keys (optional) Duplicate and rename the configuration example file to: `graphcommerce.config.js` and configure the following: -- `magentoEndpoint` [?](../framework/config.md#magentoendpoint-string) -- `hygraphEndpoint` [?](../framework/config.md#hygraphendpoint-string) -- `magentoStoreCode` [?](../framework/config.md#magentostorecode-string) +- `magentoEndpoint` [?](../framework/config.md#magentoendpoint-string-required) +- `hygraphEndpoint` [?](../framework/config.md#hygraphendpoint-string-required) +- `magentoStoreCode` + [?](../framework/config.md#magentostorecode-string-required) > magentoStoreCode > @@ -55,11 +70,12 @@ Duplicate and rename the configuration example file to: ### Requirements -- Magento version 2.4.3 or higher - Clean install, a production or a development - environment +- Magento version 2.4.5 or higher - Clean install, a production or a development + environment (technically 2.4.3 and 2.4.4 also work, but in practice important + bugfixes have been made in the latest versions.) - Hygraph - A project with the required schema. [Clone ↗](https://app.hygraph.com/clone/caddaa93cfa9436a9e76ae9c0f34d257?name=GraphCommerce%20Demo) - the schema as your starting point. + the schema as your starwting point. ## Step 3: Start the app diff --git a/examples/magento-graphcms/README.md b/examples/magento-graphcms/README.md index 38df0afe02..aafc59b172 100644 --- a/examples/magento-graphcms/README.md +++ b/examples/magento-graphcms/README.md @@ -1,17 +1,6 @@

GraphCommerce Logo

-

- - - - - - - - - -

@@ -97,7 +86,16 @@ yarn dev ## Next steps -- The [Quick start](../../docs/getting-started/readme.md) guide covers about 80% of the - concepts you'll use, so it's a great place to start. -- [Start customizing](../../docs/getting-started/start-building.md) to go from "Hello - World" to a fully built GraphCommerce custom storefront. +- The [Quick start](../../docs/getting-started/readme.md) guide covers about 80% + of the concepts you'll use, so it's a great place to start. +- [Start customizing](../../docs/getting-started/start-building.md) to go from + "Hello World" to a fully built GraphCommerce custom storefront. + +

+ + + + + + +

diff --git a/examples/magento-open-source/README.md b/examples/magento-open-source/README.md index e8170509ba..b58bd941f6 100644 --- a/examples/magento-open-source/README.md +++ b/examples/magento-open-source/README.md @@ -1,17 +1,6 @@

GraphCommerce Logo

-

- - - - - - - - - -

@@ -101,3 +90,12 @@ yarn dev of the concepts you'll use, so it's a great place to start. - [Start customizing](../../docs/getting-started/start-building.md) to go from "Hello World" to a fully built GraphCommerce custom storefront. + +

+ + + + + + +