|
1 |
| -# Next.js WordPress Starter |
| 1 | +# Next.js WordPress Starter <!-- omit in toc --> |
2 | 2 |
|
3 | 3 | WebdevStudios fork of the [official Next.js WordPress Example](https://github.com/vercel/next.js/tree/canary/examples/cms-wordpress). Used as a starter for headless WordPress projects.
|
4 | 4 |
|
5 |
| -👉 https://nextjs-wordpress-starter.vercel.app |
| 5 | +👉 https://nextjs-wordpress-starter.vercel.app |
6 | 6 |
|
7 | 7 | <a href="https://webdevstudios.com/contact/"><img src="https://webdevstudios.com/wp-content/uploads/2018/04/wds-github-banner.png" alt="WebDevStudios. Your Success is Our Mission."></a>
|
8 | 8 |
|
9 |
| -## Table of Contents |
10 |
| - - [Preface](#preface) |
11 |
| - - [Frontend Development (Next.js)](#frontend-development-nextjs) |
12 |
| - - [Install Frontend](#install-frontend) |
13 |
| - - [Backend Info (WordPress)](#backend-info-wordpress) |
14 |
| - - [Workflow](#workflow) |
15 |
| - - [Git Workflow](#git-workflow) |
16 |
| - - [Deployments](#deployments) |
17 |
| - - [Git and hosting](#git-and-hosting) |
18 |
| - - [Credentials](#credentials) |
19 |
| - - [Contributing](#contributing) |
| 9 | +## 🗂 Table of Contents |
| 10 | + |
| 11 | +- [🗂 Table of Contents](#-table-of-contents) |
| 12 | +- [🎓 Preface](#-preface) |
| 13 | +- [🚀 Getting Started](#-getting-started) |
| 14 | +- [🔧 WordPress Info (The Backend)](#-wordpress-info-the-backend) |
| 15 | +- [💻 Workflow](#-workflow) |
| 16 | + - [Local by Flywheel](#local-by-flywheel) |
| 17 | + - [Deployments](#deployments) |
| 18 | + - [Git Branches](#git-branches) |
| 19 | + - [Git Workflow](#git-workflow) |
| 20 | + - [Credentials](#credentials) |
| 21 | +- [:octocat: Contributing](#octocat-contributing) |
20 | 22 |
|
21 | 23 | ---
|
22 | 24 |
|
|
63 | 65 | cp .env.local.example .env.local
|
64 | 66 | ```
|
65 | 67 |
|
66 |
| -*The environment variable credentials are in: `1password --> Next.js Environment Variables`. Copy & paste those credentials into `.env.local`* |
| 68 | +_The environment variable credentials are in: `1password --> Next.js Environment Variables`. Copy & paste those credentials into `.env.local`_ |
67 | 69 |
|
68 | 70 | **Start the development server:**
|
69 | 71 |
|
70 | 72 | ```bash
|
71 | 73 | yarn dev
|
72 | 74 | ```
|
| 75 | + |
73 | 76 | The frontend is now available at http://localhost:3000
|
74 | 77 |
|
75 | 78 | ---
|
@@ -133,10 +136,11 @@ There is an [Local export available](https://drive.google.com/file/d/1p0qvsf2OWS
|
133 | 136 | 6. Repeat ♻️
|
134 | 137 |
|
135 | 138 | ### Credentials
|
| 139 | + |
136 | 140 | - WordPress - `1password --> "Next.js on WPE"`
|
137 | 141 | - Environment Variable - `1password --> "Next.js Environment Variables"`
|
138 | 142 | - To view hosting dashboards, ping Greg
|
139 | 143 |
|
140 |
| -## 🙌🏻 Contributing |
| 144 | +## :octocat: Contributing |
141 | 145 |
|
142 | 146 | Your [contributions](https://github.com/WebDevStudios/nextjs-wordpress-starter/blob/main/.github/CONTRIBUTING.md) and issues are welcome.
|
0 commit comments