{"id":19663192,"url":"https://github.com/pantheon-systems/gatsby-wordpress-starter","last_synced_at":"2025-04-28T21:32:28.552Z","repository":{"id":37106930,"uuid":"480565767","full_name":"pantheon-systems/gatsby-wordpress-starter","owner":"pantheon-systems","description":"This repository is a mirror. See https://github.com/pantheon-systems/decoupled-kit-js to join the discussion or submit an issue.","archived":false,"fork":false,"pushed_at":"2024-08-12T20:53:28.000Z","size":3525,"stargazers_count":3,"open_issues_count":2,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-05T11:22:37.174Z","etag":null,"topics":["gatsby","gatsby-wordpress","pantheon","starter-kit","wordpress"],"latest_commit_sha":null,"homepage":"https://github.com/pantheon-systems/decoupled-kit-js","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pantheon-systems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-11T22:02:18.000Z","updated_at":"2024-04-30T16:07:44.000Z","dependencies_parsed_at":"2024-04-02T01:00:33.099Z","dependency_job_id":null,"html_url":"https://github.com/pantheon-systems/gatsby-wordpress-starter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fgatsby-wordpress-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fgatsby-wordpress-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fgatsby-wordpress-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fgatsby-wordpress-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pantheon-systems","download_url":"https://codeload.github.com/pantheon-systems/gatsby-wordpress-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251391291,"owners_count":21582145,"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":["gatsby","gatsby-wordpress","pantheon","starter-kit","wordpress"],"created_at":"2024-11-11T16:13:40.501Z","updated_at":"2025-04-28T21:32:27.638Z","avatar_url":"https://github.com/pantheon-systems.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\u003cpicture\u003e\n  \t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/pantheon-systems/decoupled-kit-js/canary/web/static/img/W_Fist-Tagline.png\"\u003e\n  \t\u003cimg height=\"120\" alt=\"Pantheon.io logo featuring a fist capturing lighting. Pantheon™, The Platform for Extraordinary Websites.\" src=\"https://raw.githubusercontent.com/pantheon-systems/decoupled-kit-js/canary/web/static/img/B_Fist-Tagline.png\"\u003e\n\t\u003c/picture\u003e\n\t\u003ca href=\"https://decoupledkit.pantheon.io/docs#gatsby-wordpress-starter\"\u003e\n\t\t\u003ch1 style=\"margin:auto;\" align=\"center\"\u003eGatsby WordPress Starter\u003c/h1\u003e\n\t\u003c/a\u003e\n\u003c/div\u003e\n\nFor detailed documentation on the Decoupled Kit Starters, visit [the Decoupled Kit developer documentation](https://decoupledkit.pantheon.io).\n\nFor more information on using the starter on Pantheon Front-End Sites, visit [the Pantheon.io platform documentation](https://docs.pantheon.io/guides/decoupled/).\n\n## Getting Started\n\nThe Gatsby WordPress starter requires Node.js and is built and tested on the LTS version which can be found on the [Node.js downloads page](https://nodejs.org/en/download).\n\nThe starter kit supports npm, pnpm, and yarn. If you created the starer via the Pantheon Front-End Sites dashboard, it will use npm by default. To change this, delete the `package-lock.json` file and the `node-modules` folder, then run the install command of your preferred package manager.\n\nIf you created the starter via `create-pantheon-decoupled-kit`, it will detect the package manager used to run the command and use it install the starter's dependencies unless the `--noInstall` flag was used.\n\n## `@pantheon-systems` npm Packages\n\n## `@pantheon-systems/wordpress-kit` npm package\n\nThe Pantheon [`@pantheon-systems/wordpress-kit`](https://www.npmjs.com/package/@pantheon-systems/wordpress-kit) is included as a dependency in this\nproject. This allows developers to make use of utility functions to simplify the\nprocess of building and maintaining a Front-End site on Pantheon.\n\nThe `tailwindcssPlugin` is included in this project and is used to map WordPress\nBlock Editor styles to Tailwind styles.\n\nAPI reference documentation can be found at https://decoupledkit.pantheon.io/docs/Packages/wordpress-kit.\n\n### `create-pantheon-decoupled-kit`\n\nThe `create-pantheon-decoupled-kit` npm package, or \"the CLI\", is the single source of truth for all of the JavaScript/TypeScript starter kit templates. See [Using the CLI](https://decoupledkit.pantheon.io/docs/frontend-starters/using-the-cli) for more information.\n\nIn addition to scaffolding new projects, a number of add-ons are available which can be added to an existing project. For more detailed information on the available add-ons, see the [Decoupled Kit developer documentation](https://decoupledkit.pantheon.io/docs/frontend-starters/using-the-cli#add-ons).\n\n### `@pantheon-systems/decoupled-kit-health-check`\n\nTo ensure the Decoupled Kit starter has what it needs to source data from a [Decoupled Kit Backend](https://decoupledkit.pantheon.io/docs/backend-starters), a health-check is run as a part of the the build command and will error in case a critical component is not met.\n\nSee a [detailed description of the health-check here](https://github.com/pantheon-systems/decoupled-kit-js/tree/canary/packages/decoupled-kit-health-check#what-does-it-do).\n\nTo disable the health check, see [Disabling the decoupled kit health check](https://decoupledkit.pantheon.io/docs/frontend-starters/gatsby/gatsby-wordpress/troubleshooting#disabling-the-decoupled-kit-health-check)\n\n\n## Local development\n\n### Lando\n\nTo configure the starter for local development with Lando, see the [Decoupled Kit developer docs on Local Development](https://decoupledkit.pantheon.io/docs/backend-starters/decoupled-wordpress/local-development).\n\n### Commands\n\nThe Decoupled Kit starters include a number of scripts defined in the\n`package.json`. To list all of these scripts, `cd` into your starter's directory\nand in a terminal use the `npm run` command.\n\n\nSome commands include:\n\n### `develop`\n\nRuns the starter in developer mode.\n\n#### `build`\nRuns the build step for the starter. By default, the\n`@pantheon-systems/decoupled-kit-health-check` is run before the build. This\ncommand is required for Pantheon Front-End Sites.\n\n#### `serve`\nRuns the starter in local production mode.\n\n\n### `test`\nRuns the tests.\n\n### `update-snapshots`\nUpdates the snapshots used for the snapshot tests. The starter comes with an\nexample snapshot test that may need to be updating depending on your\nconfiguration.\n\n## Miscellaneous\n\n### Use `POST` for GraphQL requests\n\nThis starter uses `GET` for GraphQL requests by default in order to utilize the [WPGraphQL Smart Cache Network Cache](https://github.com/wp-graphql/wp-graphql-smart-cache/blob/main/docs/network-cache.md#network-cache). Editing this\nconfiguration to use `POST` requests can be done in `/lib/WordPressClient.js`.\n\nTo achieve this, set each `GraphQLClientFactory` constructor's `method` parameter\nto equal `POST`.\n\n```js\nexport const client = new GraphQLClientFactory(process.env.backendUrl, {\n\tmethod: 'POST',\n}).create();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantheon-systems%2Fgatsby-wordpress-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpantheon-systems%2Fgatsby-wordpress-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantheon-systems%2Fgatsby-wordpress-starter/lists"}