Skip to content

Commit 3ebc59c

Browse files
committed
chore: standardise examples readmes
1 parent 13bed5f commit 3ebc59c

File tree

7 files changed

+21
-15
lines changed

7 files changed

+21
-15
lines changed

examples/next/proxied-graphql-debug/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ npm install
7777

7878
```
7979
cd examples/next/graphql-proxy-debug
80-
npm run example:build
80+
npm run example:setup
8181
```
8282

8383
This will:
@@ -97,7 +97,7 @@ This will:
9797

9898
| Command | Description |
9999
|------------------------|-----------------------------------------------------------------------------|
100-
| `example:build` | Prepares the environment, starts WordPress, imports the database, and starts the application. |
100+
| `example:setup` | Prepares the environment, starts WordPress, imports the database, and starts the application. |
101101
| `example:dev` | Runs the Next.js development server. |
102102
| `example:dev:install` | Installs required Next.js packages. |
103103
| `example:start` | Starts WordPress and the Next.js dev server. |

examples/next/proxied-graphql-debug/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
"version": "1.0.0",
44
"description": "A debugging utility for proxied GraphQL APIs with enhanced query complexity estimation and WordPress headless integration.",
55
"scripts": {
6-
"example:build": "npm run example:dev:install && npm run wp:start && npm run wp:db:import && npm run example:start",
6+
"example:setup": "npm run example:dev:install && npm run wp:start && npm run wp:db:import && npm run example:start",
77
"example:dev:install": "cd example-app && npm install && cd ..",
88
"example:start": "npm run wp:start && npm run example:dev",
99
"example:stop": "npm run wp:stop",
10-
"example:prune": "wp-env destroy && npm run example:build && npm run example:start",
10+
"example:prune": "wp-env destroy && npm run example:setup && npm run example:start",
1111
"example:dev": "npm --prefix ./example-app run dev",
1212
"wp:start": "npm install && wp-env start",
1313
"wp:stop": "wp-env stop",

examples/next/proxied-sitemap-apollo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ http://localhost:3000/sitemap.xml
9494

9595
| Command | Description |
9696
|------------------------|-----------------------------------------------------------------------------|
97-
| `example:build` | Prepares the environment by starting WordPress, importing the database, and starting the application. |
97+
| `example:setup` | Prepares the environment by starting WordPress, importing the database, and starting the application. |
9898
| `example:dev` | Runs the Next.js development server. |
9999
| `example:dev:install` | Installs the required Next.js packages. |
100100
| `example:start` | Starts WordPress and the Next.js development server. |

examples/next/proxied-sitemap-apollo/example-app/package-lock.json

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/next/proxied-sitemap-apollo/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
"version": "1.0.0",
44
"description": "A Next.js application that proxies WordPress sitemaps to a headless site and transforms them with clean URL formatting using Apollo Client.",
55
"scripts": {
6-
"example:build": "npm run example:dev:install && npm run wp:start && npm run wp:db:import && npm run example:start",
6+
"example:setup": "npm run example:dev:install && npm run wp:start && npm run wp:db:import && npm run example:start",
77
"example:dev:install": "cd example-app && npm install && cd ..",
88
"example:start": "npm run wp:start && npm run example:dev",
99
"example:stop": "npm run wp:stop",
10-
"example:prune": "wp-env destroy && npm run example:build && npm run example:start",
10+
"example:prune": "wp-env destroy && npm run example:setup && npm run example:start",
1111
"example:dev": "npm --prefix ./example-app run dev",
1212
"wp:start": "npm install && wp-env start",
1313
"wp:stop": "wp-env stop",

examples/nuxt/nuxt-headlesswp-gravity-forms/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ This example shows you how to wire up a full headless WordPress backend—comple
2323

2424
```
2525
26-
```
27-
2826
example-app/
2927
├── components/ # Vue form-field components & barrel file
3028
├── composables/ # useGravityForm.js & useFormFields.js
@@ -51,8 +49,8 @@ wp-env/
5149
### Setup Repository and Install
5250
5351
```bash
54-
git clone https://github.com/your-org/nuxt-gravityforms-example.git
55-
cd nuxt-gravityforms-example
52+
git clone https://github.com/wpengine/hwptoolkit.git
53+
cd examples/nuxt/nuxt-headlesswp-gravity-forms
5654
npm install
5755
5856
echo "NUXT_PUBLIC_WORDPRESS_URL=http://localhost:8888" > example-app/.env
@@ -63,7 +61,7 @@ echo "NUXT_PUBLIC_WORDPRESS_URL=http://localhost:8888" > example-app/.env
6361
1. Start WP, import DB, then launch Nuxt:
6462
6563
```bash
66-
npm run example:build
64+
npm run example:setup
6765
```
6866

6967
2. Or run steps separately:
@@ -89,7 +87,7 @@ By the end, you will have:
8987

9088
| Command | Description |
9189
| ------------------------- | ---------------------------------------------------------------- |
92-
| `npm run example:build` | Start WP env → import DB → launch Nuxt dev server |
90+
| `npm run example:setup` | Start WP env → import DB → launch Nuxt dev server |
9391
| `npm run example:start` | Start WP env, then Nuxt dev server |
9492
| `npm run example:stop` | Stop the WordPress environment (wp-env stop) |
9593
| `npm run example:prune` | Destroy & rebuild the WP environment, then restart—all in one go |

examples/nuxt/nuxt-headlesswp-gravity-forms/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
"name": "headlesswp-gravity-forms-nuxt-env",
33
"version": "1.0.0",
44
"scripts": {
5-
"example:build": "npm run example:dev:install && npm run wp:start && npm run example:start",
5+
"example:setup": "npm run example:dev:install && npm run wp:start && npm run example:start",
66
"example:dev:install": "cd example-app && npm install && cd ..",
77
"example:start": "npm run wp:start && npm run example:dev",
88
"example:stop": "npm run wp:stop",
9-
"example:prune": "wp-env destroy && npm run example:build && npm run example:start",
9+
"example:prune": "wp-env destroy && npm run example:setup && npm run example:start",
1010
"example:dev": "npm --prefix ./example-app run dev",
1111
"wp:start": "npm install && wp-env start",
1212
"wp:stop": "wp-env stop",

0 commit comments

Comments
 (0)