You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 27, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Our fork of the [official Next.js WordPress Example](https://github.com/vercel/n
20
20
21
21
---
22
22
23
-
## Preface
23
+
## 🎓 Preface
24
24
25
25
You will need the following installed on your computer:
26
26
@@ -40,33 +40,33 @@ The WordPress backend is running [WPGraphQL](https://github.com/wp-graphql/wp-gr
40
40
41
41
---
42
42
43
-
## Frontend Development (Next.js)
43
+
## 🚀 Getting Started
44
44
45
45
The following instructions will standup a local install of the frontend. It queries data from the WordPress backend via GraphQL. Authentication happens via environment variable `.env.local`.
*The environment variable credentials are in: `1password --> Next.js Environment Variables`. Copy & paste those credentials into `.env.local`*
68
68
69
-
Start the development server:
69
+
**Start the development server:**
70
70
71
71
```bash
72
72
yarn start
@@ -75,27 +75,27 @@ The frontend will be available at http://localhost:3000
75
75
76
76
---
77
77
78
-
## Backend Info (WordPress)
78
+
## 🔧 Backend Info (WordPress)
79
79
80
80
A vanilla WordPress install hosted at [WP Engine](https://nextjs.wpengine.com) with the following plugins are installed:
81
81
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
+
1.`Advanced Custom Fields Pro`: At WebDevStudios we leverage ACF to handle custom post meta and [ACF Blocks](https://www.advancedcustomfields.com/resources/blocks/).
83
83
84
-
**reSmush.it Image Optimizer** - Keeps image sizes small by optimizing them on upload.
84
+
2.`reSmush.it Image Optimizer`: Keeps image sizes small by optimizing them on upload.
85
85
86
-
**WDS SSO** - Used as our internal single-sign on service.
86
+
3.`WDS SSO`: Used as our internal single-sign on service.
87
87
88
-
**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
+
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`
89
89
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 Next.js 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
+
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.
91
91
92
-
**WP Migrate DB Pro** - Used for moving database and files between environments.
92
+
5.`WP Migrate DB Pro`: Used for moving database and files between environments.
93
93
94
-
**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
+
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.*
95
95
96
96
---
97
97
98
-
## Workflow
98
+
## 💻 Workflow
99
99
100
100
Contributing to this project is a lot like any other WDS project...
101
101
@@ -122,6 +122,6 @@ Vercel is connected to the WebDevStudios Github account. Deployment previews are
122
122
- See 1password "Next.js Environment Variables"
123
123
- To view frontend hosting dashboard, ping Greg
124
124
125
-
## Contributing
125
+
## 🙌🏻 Contributing
126
126
127
127
Your contributions and support tickets are welcome.
0 commit comments