Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README #2439

Merged
merged 2 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/neat-timers-unite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@graphcommerce/docs': patch
'@graphcommerce/service-worker': patch
---

Moved to serwist for service workers
38 changes: 27 additions & 11 deletions docs/getting-started/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
>
Expand All @@ -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

Expand Down
28 changes: 13 additions & 15 deletions examples/magento-graphcms/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
<p align="center">
<a href="https://www.graphcommerce.org/"><img src="https://graphcommerce.vercel.app/favicon.svg" alt="GraphCommerce Logo"/></a>
</p>
<p align="center">
<a aria-label="License" href="https://www.npmjs.com/package/@graphcommerce/magento-graphcms">
<img alt="" src="https://img.shields.io/npm/v/@graphcommerce/magento-graphcms?style=for-the-badge">
</a>
<a aria-label="License" href="https://github.com/graphcommerce-org/graphcommerce/blob/main/LICENSE.md">
<img alt="" src="https://img.shields.io/badge/License-ELv2-green?style=for-the-badge">
</a>
<a aria-label="Vercel logo" href="https://vercel.com?utm_source=graphcommerce&utm_campaign=oss">
<img src="https://img.shields.io/badge/POWERED%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
</a>
</p>

<div align="center">

Expand Down Expand Up @@ -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.

<p align="center">
<a aria-label="License" href="https://github.com/graphcommerce-org/graphcommerce/blob/main/LICENSE.md">
<img alt="" src="https://img.shields.io/badge/License-ELv2-green?style=for-the-badge">
</a>
<a aria-label="Vercel logo" href="https://vercel.com?utm_source=graphcommerce&utm_campaign=oss">
<img src="https://img.shields.io/badge/POWERED%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
</a>
</p>
20 changes: 9 additions & 11 deletions examples/magento-open-source/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
<p align="center">
<a href="https://www.graphcommerce.org/"><img src="https://graphcommerce.vercel.app/favicon.svg" alt="GraphCommerce Logo"/></a>
</p>
<p align="center">
<a aria-label="License" href="https://www.npmjs.com/package/@graphcommerce/magento-open-source">
<img alt="" src="https://img.shields.io/npm/v/@graphcommerce/magento-open-source?style=for-the-badge">
</a>
<a aria-label="License" href="https://github.com/graphcommerce-org/graphcommerce/blob/main/LICENSE.md">
<img alt="" src="https://img.shields.io/badge/License-ELv2-green?style=for-the-badge">
</a>
<a aria-label="Vercel logo" href="https://vercel.com?utm_source=graphcommerce&utm_campaign=oss">
<img src="https://img.shields.io/badge/POWERED%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
</a>
</p>

<div align="center">

Expand Down Expand Up @@ -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.

<p align="center">
<a aria-label="License" href="https://github.com/graphcommerce-org/graphcommerce/blob/main/LICENSE.md">
<img alt="" src="https://img.shields.io/badge/License-ELv2-green?style=for-the-badge">
</a>
<a aria-label="Vercel logo" href="https://vercel.com?utm_source=graphcommerce&utm_campaign=oss">
<img src="https://img.shields.io/badge/POWERED%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
</a>
</p>