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

Commit ed2112c

Browse files
committed
bump
1 parent c8fe987 commit ed2112c

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Our fork of the [official Next.js WordPress Example](https://github.com/vercel/n
2020

2121
---
2222

23-
## Preface
23+
## 🎓 Preface
2424

2525
You will need the following installed on your computer:
2626

@@ -40,33 +40,33 @@ The WordPress backend is running [WPGraphQL](https://github.com/wp-graphql/wp-gr
4040

4141
---
4242

43-
## Frontend Development (Next.js)
43+
## 🚀 Getting Started
4444

4545
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`.
4646

4747
### Install Frontend
4848

49-
Clone the repo:
49+
**Clone the repo:**
5050

5151
```bash
5252
git clone [email protected]:WebDevStudios/nextjs-wordpress-starter.git
5353
```
5454

55-
Install dependencies:
55+
**Install dependencies:**
5656

5757
```bash
5858
yarn
5959
```
6060

61-
Create an environment variable:
61+
**Create an environment variable:**
6262

6363
```bash
6464
cp .env.local.example .env.local
6565
```
6666

6767
*The environment variable credentials are in: `1password --> Next.js Environment Variables`. Copy & paste those credentials into `.env.local`*
6868

69-
Start the development server:
69+
**Start the development server:**
7070

7171
```bash
7272
yarn start
@@ -75,27 +75,27 @@ The frontend will be available at http://localhost:3000
7575

7676
---
7777

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

8080
A vanilla WordPress install hosted at [WP Engine](https://nextjs.wpengine.com) with the following plugins are installed:
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+
1. `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-
**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.
8585

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

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`
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 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.
9191

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.
9393

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.*
9595

9696
---
9797

98-
## Workflow
98+
## 💻 Workflow
9999

100100
Contributing to this project is a lot like any other WDS project...
101101

@@ -122,6 +122,6 @@ Vercel is connected to the WebDevStudios Github account. Deployment previews are
122122
- See 1password "Next.js Environment Variables"
123123
- To view frontend hosting dashboard, ping Greg
124124

125-
## Contributing
125+
## 🙌🏻 Contributing
126126

127127
Your contributions and support tickets are welcome.

0 commit comments

Comments
 (0)