{"id":18328116,"url":"https://github.com/wpengine/atlas-shopify-blueprint","last_synced_at":"2025-04-06T01:32:22.171Z","repository":{"id":173119600,"uuid":"621415473","full_name":"wpengine/atlas-shopify-blueprint","owner":"wpengine","description":"Atlas Shopify Blueprint","archived":false,"fork":false,"pushed_at":"2025-03-25T11:00:50.000Z","size":4575,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":37,"default_branch":"develop","last_synced_at":"2025-04-02T20:56:11.850Z","etag":null,"topics":["rd"],"latest_commit_sha":null,"homepage":"https://atlasshopify.wpengine.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wpengine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-30T16:03:53.000Z","updated_at":"2025-03-25T11:00:53.000Z","dependencies_parsed_at":"2023-09-23T13:00:08.509Z","dependency_job_id":"e40038b8-2103-4768-80f2-bcd642162ab6","html_url":"https://github.com/wpengine/atlas-shopify-blueprint","commit_stats":null,"previous_names":["wpengine/atlas-shopify-blueprint"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Fatlas-shopify-blueprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Fatlas-shopify-blueprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Fatlas-shopify-blueprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Fatlas-shopify-blueprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wpengine","download_url":"https://codeload.github.com/wpengine/atlas-shopify-blueprint/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423477,"owners_count":20936621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rd"],"created_at":"2024-11-05T19:13:11.701Z","updated_at":"2025-04-06T01:32:17.228Z","avatar_url":"https://github.com/wpengine.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Headless Platform Shopify Blueprint\n\nA Shopify template for Headless Platform Blueprints.\n\nThis repository contains a starter Blueprint to get you up and running quickly on WP Engine's Headless Platform with a simple WordPress site that uses product data from Shopify.\n\n- [Check out the demo store here](https://atlasshopify.wpengine.com)\n- [Try a sandbox version of Headless Platform to get started with this Blueprint](https://wpengine.com/headless-wordpress/)\n- [Documentation can be found here](https://developers.wpengine.com/docs/atlas-shopify-blueprint/introduction)\n\n## Development\n\nCopy `.env.local.sample` to `.env.local` in your local development environment to set environment variables locally. The sample env file points to the demo Shopify Blueprint Wordpress site, but you can change it to point to a local Wordpress site instead.\n\n[Add your Shopify variables to configure the Shopify Client](#configuring-shopify-locally-and-on-atlas).\n\nInstall dependencies with `npm install` - if you run into issues try `npm install --legacy-peer-deps`\n\nMake sure that any Wordpress site that is connected to this headless site has its Permalinks set to use this custom structure:\n\n```\n/posts/%postname%/\n```\n\n## Architecture Decision Records\n\nSee the `docs/adr` directory for a list of architectural decision records made so far.\n\n## Tests\n\nComponents are tested using [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) and [Jest](https://jestjs.io/docs/getting-started)\n\nTo run tests `npm run test`\n\n## Linting and pre commit hooks\n\n[Eslint](https://eslint.org/) and Prettier are used for linting and formatting. Please have [Prettier](https://prettier.io/) installed in Vs Code when developing locally to adhere to formatting standards. For pre commit linting and formatting we use [Husky](https://github.com/typicode/husky). This will run when a you run a commit, if it fails check the Node logs for issues that need to be solved before committing again.\n\n## NVM ( Node Version Manager )\n\n`.nvmrc` is specifying that Node.js `v18` should be used. Any developer could then run `nvm use` to download, install, and switch to that version. `nvm install` will then install dependencies in line with that version.\n\n## Configuring Shopify locally and on Headless Platform\n\nIn addition to default environment variables the Shopify Blueprint needs to add 2 more as follows:\n\n- NEXT_PUBLIC_SHOPIFY_HEADLESS_PUBLIC_ACCESS_TOKEN\n- NEXT_PUBLIC_SHOPIFY_GRAPHQL_URL\n\nFor local development these can be added to `.env.local` and for production deployments these can be added in Headless Platform Dashboard. See [WP Engine headless docs for directions on how to configure Headless Platform Environment Variables](https://developers.wpengine.com/docs/atlas/local-app-development/frontend-app-config#2--define-environment-variables).\n\n## Creating a new Github release\n\nThe steps involved with creating a new release are as follows :\n\n1. Update the version in `package.json`\n2. Run `npm install` and check the new version in the generated `package-lock.json`\n3. Create a PR against `develop` with the version update. Review and merge the PR.\n4. Create a PR from `develop` into the `main` branch and make sure it includes all the changes that are intended to be in the release. Review and merge the PR.\n5. In the User Portal (production), create a new Headless Platform App using the Shopify Blueprint and verify if changes are there and the version is correct.\n6. Create a new release in Github with the tag as the latest version with `main` as the target. (For description you can use the `generate release notes` button)\n7. Post a message to [#team-pe-titan-public](https://wpengine.slack.com/archives/C04SJP4UBB7) using the following template:\n   \u003e 🚀 Headless Platform Shopify Blueprint - Version X.Y.Z 🚀\n   \u003e We have released a new version of the blueprint. \u003cShort sentences summarising the changes added\u003e. For more details, follow this link: https://github.com/wpengine/atlas-shopify-blueprint/releases/tag/X.Y.Z\n\n## For more information\n\nFor more information on this Blueprint please check out the following sources:\n\n- [WP Engine's Headless Platform](https://wpengine.com/headless-wordpress/)\n- [Faust.js](https://faustjs.org/)\n- [WPGraphQL](https://www.wpgraphql.com/)\n- [Atlas Content Modeler](https://wordpress.org/plugins/atlas-content-modeler/)\n- [Shopify Storefront API](https://shopify.dev/docs/api/storefront)\n- [WP Engine's Headless Platform developer community](https://wpengine.com/builders/headless)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpengine%2Fatlas-shopify-blueprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwpengine%2Fatlas-shopify-blueprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpengine%2Fatlas-shopify-blueprint/lists"}