Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit baa7a84

Browse files
committed
bump
1 parent 7a40ebd commit baa7a84

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The following frontend technologies are used on this project:
3636
- [PostCSS](https://postcss.org/)
3737
- [PropTypes](https://reactjs.org/docs/typechecking-with-proptypes.html)
3838

39-
The WordPress backend is running [WPGraphQL](https://github.com/wp-graphql/wp-graphql). So familiarity with writing [GraphQL](https://graphql.org/) queries is helpful.
39+
The backend (WordPress) is running [WPGraphQL](https://github.com/wp-graphql/wp-graphql). So familiarity with writing [GraphQL](https://graphql.org/) queries is helpful, but not required.
4040

4141
---
4242

@@ -75,21 +75,21 @@ The frontend will be available at http://localhost:3000
7575

7676
---
7777

78-
## 🔧 Backend Info (WordPress)
78+
## 🔧 WordPress Info (The Backend)
7979

80-
The backend is a vanilla WordPress install hosted at [WP Engine](https://nextjs.wpengine.com), with the following plugins installed:
80+
The backend is a vanilla WordPress install, hosted at [WP Engine](https://nextjs.wpengine.com) with the following plugins:
8181

82-
**Advanced Custom Fields Pro** - At WebDevStudios we leverage ACF to handle custom post meta and [ACF Blocks](https://www.advancedcustomfields.com/resources/blocks/).
82+
**Advanced Custom Fields Pro** - ACF handles custom post meta and [ACF Blocks](https://www.advancedcustomfields.com/resources/blocks/).
8383

8484
**reSmush.it Image Optimizer** - Keeps image sizes small by optimizing them on upload.
8585

86-
**WDS SSO** - Used as our internal single-sign on service.
86+
**WDS SSO** - Our internal single-sign on service.
8787

88-
**WP GraphQL** - GraphQL is installed on the WordPress backend and the endpoint is: `https://nextjs.wpengine.com/graphql`
88+
**WP GraphQL** - GraphQL is installed and the endpoint is: `https://nextjs.wpengine.com/graphql`
8989

90-
**WP GraphiQL** - You can use WP GraphiQL to build queries in the [WordPress Dashboard](https://nextjs.wpengine.com/wp-admin/admin.php?page=wp-graphiql%2Fwp-graphiql.php). Those queries can be copied and pasted right into the frontend. You can view the current list of GraphQL queries in [/lib/api.js](https://github.com/WebDevStudios/nextjs-wordpress-starter/blob/main/lib/api.js)
90+
**WP GraphiQL** - Use WP GraphiQL to build queries in the [WordPress Dashboard](https://nextjs.wpengine.com/wp-admin/admin.php?page=wp-graphiql%2Fwp-graphiql.php). Those queries can be copied and pasted right into [/lib/api.js](https://github.com/WebDevStudios/nextjs-wordpress-starter/blob/main/lib/api.js)
9191

92-
**WP GraphQL JWT** - JWT Authentication allows the frontend to talk to the backend via environment variable `.env.local`
92+
**WP GraphQL JWT** - Allows the frontend to talk to the backend via environment variable `.env.local`
9393

9494
**WP Migrate DB Pro** - Used for moving database and files between environments.
9595

@@ -105,6 +105,15 @@ Contributing to this project is a lot like any other WDS project...
105105

106106
There is an [Local export available](https://drive.google.com/file/d/1p0qvsf2OWSr0Wesl2rrxhwJxHW3JUAMg/view?usp=sharing). Simply import the `.zip` file and you can tinker with the WordPress backend.
107107

108+
### Deployments
109+
110+
[Vercel](https://vercel.com/webdevstudios/nextjs-wordpress-example) is connected to this repo and handles builds deployments:
111+
112+
### Branches
113+
114+
- `main` - auto deploys
115+
- `Pull Requests` - deployment previews are automatically generated
116+
108117
### Git Workflow
109118

110119
1. Create a `feature` branch off `main`
@@ -114,13 +123,6 @@ There is an [Local export available](https://drive.google.com/file/d/1p0qvsf2OWS
114123
4. After peer review, PR will be merged back into `main`
115124
5. Repeat ♻️
116125

117-
### Deployments
118-
119-
[Vercel](https://vercel.com/webdevstudios/nextjs-wordpress-example) is connected to this repo and handles builds deployments
120-
121-
- `main` - auto deploys
122-
- Deployment previews are available for Pull Requests
123-
124126
### Credentials
125127
- WordPress - 1password --> "Next.js on WPE"
126128
- Environment Variable - 1password --> "Next.js Environment Variables"

0 commit comments

Comments
 (0)