https://github.com/softcommerceltd/magento-graphcommerce-pwa
https://github.com/softcommerceltd/magento-graphcommerce-pwa
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/softcommerceltd/magento-graphcommerce-pwa
- Owner: softcommerceltd
- Created: 2024-05-27T09:03:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T16:36:01.000Z (over 1 year ago)
- Last Synced: 2024-12-19T17:37:10.257Z (over 1 year ago)
- Language: TypeScript
- Size: 433 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
📚 [Docs](https://graphcommerce.org/docs) | 🗣
[Slack](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
| 📝
[Release notes](https://github.com/graphcommerce-org/graphcommerce/releases)
GraphCommerce is a framework for building headless ecommerce storefronts in
React and Next.js. It provides a best-in-class example, including components and
utilities, to deliver a high-performance, high-quality ecommerce Progressive Web
App (PWA).
Explore the [GraphCommerce demo](https://graphcommerce.vercel.app/) or start
building your custom GraphCommerce ecommerce frontend.
https://user-images.githubusercontent.com/1251986/226889542-ec403549-5e4f-4ff6-8fc5-ba879798353f.mp4
The GraphCommerce homepage, showcasing content from both Magento and Hygraph
through a variety of included UX components.
---
# Getting started with GraphCommerce
In this guide, you will set up a GraphCommerce app locally, allowing you to
start building.
### Requirements
- Install and use node 16/18: `nvm install 16` or `nvm use 16`
- Install yarn: `corepack enable`
## Step 1: Create a GraphCommerce app
```bash
git clone -b main --depth 1 https://github.com/graphcommerce-org/graphcommerce.git
# Clone repository
```
```bash
mkdir my-project
# Create project folder
```
```bash
cp -R graphcommerce/examples/magento-graphcms/. my-project && rm -rf graphcommerce && cd my-project
# Copy example, delete repo, navigate to project folder
```
## Step 2: Configure API keys
(Optional,
[continue reading](https://www.graphcommerce.org/docs/getting-started/create))
## Step 3: Start the app
```bash
yarn
# Install the dependencies
```
```bash
yarn codegen
# Converts all .graphql files to typescript files
```
```bash
yarn dev
# Run the app
```
---
🎉 Explore your GraphCommerce app running at http://localhost:3000
(Explore the GraphQL Playground running at http://localhost:3000/api/graphql)
> No success? Consult the
> [troubleshooting guide](../../docs/framework/troubleshooting.md)
## 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.