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

Commit 8a8ba29

Browse files
committed
bump
1 parent 74602cc commit 8a8ba29

File tree

2 files changed

+25
-17
lines changed

2 files changed

+25
-17
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These owners will be the default owners for everything in
2+
# the repo. Unless a later match takes precedence.
3+
# See https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
4+
* @gregrickaby

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -79,48 +79,52 @@ The frontend will be available at http://localhost:3000
7979

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

82-
1. `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` - At WebDevStudios we leverage ACF to handle custom post meta and [ACF Blocks](https://www.advancedcustomfields.com/resources/blocks/).
8383

84-
2. `reSmush.it Image Optimizer`: Keeps image sizes small by optimizing them on upload.
84+
`reSmush.it Image Optimizer` - Keeps image sizes small by optimizing them on upload.
8585

86-
3. `WDS SSO`: Used as our internal single-sign on service.
86+
`WDS SSO` - Used as our internal single-sign on service.
8787

88-
4. `WP GraphQL, WP GraphiQL, and WP GraphQL JWT Authentication`: GraphQL is installed on the WordPress backend and the endpoint is: `https://nextjs.wpengine.com/graphql`
88+
`WP GraphQL` - GraphQL is installed on the WordPress backend and the endpoint is: `https://nextjs.wpengine.com/graphql`
8989

90-
You can use GrapiQL 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) JWT Authentication allows the frontend to talk to the backend.
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)
9191

92-
5. `WP Migrate DB Pro`: Used for moving database and files between environments.
92+
`WP GraphQL JWT`: JWT Authentication allows the frontend to talk to the backend via environment variable `.env.local`
9393

94-
6. `There is no frontend for WordPress`: But it is running [wd_s](https://github.com/WebDevStudios/wd_s). wd_s houses `/acf-json` and other functions for building ACF Blocks. *If you try to view the WordPress frontend, you will be redirected back to the WordPress dashboard.*
94+
`WP Migrate DB Pro`: Used for moving database and files between environments.
95+
96+
`There is no frontend for WordPress`: But it is running [wd_s](https://github.com/WebDevStudios/wd_s). wd_s houses `/acf-json` and other functions for building ACF Blocks. *If you try to view the WordPress frontend, you will be redirected back to the WordPress dashboard.*
9597

9698
---
9799

98100
## 💻 Workflow
99101

100102
Contributing to this project is a lot like any other WDS project...
101103

104+
### Local by Flywheel
105+
106+
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.
107+
102108
### Git Workflow
103109

104110
1. Create a `feature` branch off `main`
105111
2. Open a draft Pull Request on Github
106-
3. When finished with your work, undraft, and assign to Lead Engineer for peer review
112+
3. When finished with your work, publish your PR, and assign to Lead Engineer for peer review
113+
4. Vercel will create a deployment preview. It must pass and deploy successfully
107114
4. After peer review, PR will be merged back into `main`
108115
5. Repeat ♻️
109116

110117
### Deployments
111118

112-
Vercel is connected to the WebDevStudios Github account. Deployment previews are available for PRs, and merges into `main` are auto deployed.
119+
[Vercel](https://vercel.com/webdevstudios/nextjs-wordpress-example) is connected to this repo and handles builds deployments
113120

114-
### Git and hosting
115-
- Backend Hosting https://my.wpengine.com/installs/nextjs
116-
- Frontend Hosting https://vercel.com/webdevstudios/
117-
- Frontend code repo https://github.com/WebDevStudios/nextjs-wordpress-starter
118-
- Backend code repo N/A
121+
- `main` - auto deploys
122+
- Deployment previews are available for Pull Requests
119123

120124
### Credentials
121-
- See 1password "Next.js on WPE"
122-
- See 1password "Next.js Environment Variables"
123-
- To view frontend hosting dashboard, ping Greg
125+
- WordPress - 1password --> "Next.js on WPE"
126+
- Environment Variable - 1password --> "Next.js Environment Variables"
127+
- To view hosting dashboards, ping Greg
124128

125129
## 🙌🏻 Contributing
126130

0 commit comments

Comments
 (0)