Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pantheon-systems/gatsby-wordpress-starter
This repository is a mirror. See https://github.com/pantheon-systems/decoupled-kit-js to join the discussion or submit an issue.
https://github.com/pantheon-systems/gatsby-wordpress-starter
gatsby gatsby-wordpress pantheon starter-kit wordpress
Last synced: 9 days ago
JSON representation
This repository is a mirror. See https://github.com/pantheon-systems/decoupled-kit-js to join the discussion or submit an issue.
- Host: GitHub
- URL: https://github.com/pantheon-systems/gatsby-wordpress-starter
- Owner: pantheon-systems
- License: gpl-3.0
- Created: 2022-04-11T22:02:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T16:07:40.000Z (7 months ago)
- Last Synced: 2024-04-30T17:27:38.077Z (7 months ago)
- Topics: gatsby, gatsby-wordpress, pantheon, starter-kit, wordpress
- Language: TypeScript
- Homepage: https://github.com/pantheon-systems/decoupled-kit-js
- Size: 3.14 MB
- Stars: 3
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
For detailed documentation on the Decoupled Kit Starters, visit [the Decoupled Kit developer documentation](https://decoupledkit.pantheon.io).
For more information on using the starter on Pantheon Front-End Sites, visit [the Pantheon.io platform documentation](https://docs.pantheon.io/guides/decoupled/).
## Getting Started
The 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).
The 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.
If 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.
## `@pantheon-systems` npm Packages
## `@pantheon-systems/wordpress-kit` npm package
The Pantheon [`@pantheon-systems/wordpress-kit`](https://www.npmjs.com/package/@pantheon-systems/wordpress-kit) is included as a dependency in this
project. This allows developers to make use of utility functions to simplify the
process of building and maintaining a Front-End site on Pantheon.
The `tailwindcssPlugin` is included in this project and is used to map WordPress
Block Editor styles to Tailwind styles.
API reference documentation can be found at https://decoupledkit.pantheon.io/docs/Packages/wordpress-kit.
### `create-pantheon-decoupled-kit`
The `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.
In 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).
### `@pantheon-systems/decoupled-kit-health-check`
To 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.
See 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).
To 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)
## Local development
### Lando
To 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).
### Commands
The Decoupled Kit starters include a number of scripts defined in the
`package.json`. To list all of these scripts, `cd` into your starter's directory
and in a terminal use the `npm run` command.
Some commands include:
### `develop`
Runs the starter in developer mode.
#### `build`
Runs the build step for the starter. By default, the
`@pantheon-systems/decoupled-kit-health-check` is run before the build. This
command is required for Pantheon Front-End Sites.
#### `serve`
Runs the starter in local production mode.
### `test`
Runs the tests.
### `update-snapshots`
Updates the snapshots used for the snapshot tests. The starter comes with an
example snapshot test that may need to be updating depending on your
configuration.
## Miscellaneous
### Use `POST` for GraphQL requests
This 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
configuration to use `POST` requests can be done in `/lib/WordPressClient.js`.
To achieve this, set each `GraphQLClientFactory` constructor's `method` parameter
to equal `POST`.
```js
export const client = new GraphQLClientFactory(process.env.backendUrl, {
method: 'POST',
}).create();
```
