Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 85 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,87 @@
# cms-wordpress

[Vercel's Next.js Starter for WordPress Headless CMS](https://github.com/9d8dev/next-wp) on
**Cloudflare Workers**, deployed by [Orun](https://github.com/sourceplane/orun) to stage
and prod on every merge, and then packaged as an Orun baseline.

This commit is the repository's frame: `intent.yaml` (with the placeholder
workspace `ws_CHANGE_ME`, so CI plans nothing until it is linked), the Orun
CI workflow, the shared TypeScript and ESLint configuration, and the spec
index. The work is tracked as an epic under [`specs/epics`](specs/epics/README.md).
Vercel's [Next.js Starter for WordPress Headless CMS](https://github.com/9d8dev/next-wp)
(9d8's `next-wp`) — posts, pages, categories, tags and authors read from a
WordPress site's REST API through one typed client, with search, filters and
pagination, a sitemap, Open Graph images, shadcn/ui and light and dark
themes, and a revalidation webhook for WordPress's next-revalidate plugin —
running on **Cloudflare Workers + Static Assets** through
[`@opennextjs/cloudflare`](https://opennext.js.org/cloudflare), deployed by
[Orun](https://github.com/sourceplane/orun) to stage and prod on every merge.
Packaging it as an Orun baseline is the next milestone (WP2).

The template's code is the code and WordPress stays the owner's own site.
What the port adds is the Workers build, the monorepo wrapper, a test
package and the deploy contract; what it changes is what Workers force:
every page renders on request and reads WordPress afresh instead of ISR on a
read-only cache, the Open Graph image runs on the Node.js runtime instead of
the edge, images are served unoptimised, and Vercel Analytics becomes the
Cloudflare Web Analytics beacon — and what makes it deployable before its
owner has connected a WordPress: an unconnected build renders bundled sample
posts under a visible notice instead of empty lists. See
[`specs/epics/cms-wordpress`](specs/epics/cms-wordpress/README.md) for the
design, the milestones and the as-built status.

## What is here (the site)

| Surface | Where |
|---|---|
| Home, `/posts` (search, filters, pagination), `/posts/[slug]`, `/pages`, `/pages/[slug]`, the category, tag and author lists | `apps/web/app` |
| The WordPress REST client and its types | `apps/web/lib/wordpress.ts`, `apps/web/lib/wordpress.d.ts` |
| The sample content an unconnected site renders, and its notice | `apps/web/lib/sample.ts`, `apps/web/components/unconnected-notice.tsx` |
| The revalidation webhook, the Open Graph image, the sitemap | `apps/web/app/api/revalidate`, `apps/web/app/api/og`, `apps/web/app/sitemap.ts` |
| The site's name (the rename's seam), description and origin | `apps/web/site.config.ts` |
| Workers build and deploy contract | `apps/web/next.config.ts`, `open-next.config.ts`, `wrangler.jsonc`, `component.yaml` |
| Tests (the template's own, plus the sample mode and the name seam) | `tests/web` (vitest) |

## Getting started

```bash
pnpm install
pnpm typecheck
pnpm lint
pnpm test
pnpm build # next build + opennextjs-cloudflare build → apps/web/.open-next
pnpm --filter @app/web preview # wrangler dev over the built Worker: the sample site, unconnected
```

That much needs no WordPress, and it is what to run before a push: a pull
request builds and dry-deploys the site, and does not lint or run the tests.
To see your own content:

```bash
cd apps/web
cp .env.example .env.local # WORDPRESS_URL=https://<your-site>
cd ../..
pnpm --filter @app/web dev # http://localhost:3000
```

| Variable | Where it is read | What it does |
|---|---|---|
| `WORDPRESS_URL` | build time (`next build` inlines it into the server bundle) | The WordPress site. A deployed build takes it from its environment's `WORDPRESS_URL` secret, best-effort. Unset, the site is unconnected: the sample content under a notice. |
| `WORDPRESS_HOSTNAME` | build time | The template's next/image allow-list for media; the URL's own when unset. Inert while images are unoptimised. |
| `NEXT_PUBLIC_SITE_URL` | build time | The origin of the sitemap, canonical and Open Graph links; the deploy sets it per environment (`SITE_URL`, else the workers.dev URL). |
| `WORDPRESS_WEBHOOK_SECRET` | request time, in the Worker | The secret `/api/revalidate` checks. A Worker secret in stage/prod, `.dev.vars` locally. Optional: without it every webhook is refused with 401. |
| `NEXT_PUBLIC_CF_BEACON_TOKEN` | build time | Optional. Cloudflare Web Analytics token. Unset, no script is rendered. |

## How it maps to Vercel

| Vercel | Here |
|---|---|
| Next.js hosting (posts and pages pre-rendered by `generateStaticParams`, a data cache with tags and a one-hour revalidate, route handlers) | One Cloudflare Worker (`.open-next/worker.js`) + Static Assets; every page that reads WordPress renders on request (`force-dynamic`, fetches `no-store`), the home page and the 404 are pre-rendered and served from the static-assets cache |
| On-demand revalidation (`/api/revalidate` → `revalidateTag`, called by the next-revalidate plugin) | The route is kept and checks its secret as before; there is no cache for it to clear, because nothing is cached — a published change shows on the next visit |
| `export const runtime = "edge"` on `/api/og` | The Node.js runtime under `nodejs_compat` (OpenNext runs no edge functions); next/og renders the same PNG |
| Image Optimization (`next/image`, WordPress's host allowed) | Off (`images.unoptimized`): the Worker has no optimiser, media is served from WordPress as uploaded |
| `@vercel/analytics` | Cloudflare Web Analytics beacon (`components/analytics.tsx`) |
| Project env vars in the dashboard (`WORDPRESS_URL`, `WORDPRESS_HOSTNAME`, `WORDPRESS_WEBHOOK_SECRET`) | Build time: the URL from an optional Orun secret per environment, inlined by `next build`. Run time: the webhook secret as a Worker secret |
| No `WORDPRESS_URL`: empty lists | An unconnected site: sample posts, a page, terms and an author, under a notice — deployable before a WordPress is connected |
| `site_domain: "https://next-wp.com"` | `NEXT_PUBLIC_SITE_URL`, set per environment by the deploy: its `SITE_URL`, else its workers.dev URL |
| The Railway template (WordPress, MySQL and the site in Docker) | Not carried: WordPress is the owner's own, wherever it runs; the plugin is upstream's release download |
| Deploy on push | Orun deploys `<repo>-web-{stage,prod}` on merge to `main` and smoke-tests it (`apps/web/component.yaml`) |
| "Deploy with Vercel" (clone the template) | `orun new --blueprint repo-blueprint.yaml` — a new repository, branded, deployed |

## CI

| Workflow | What it runs | Ships to a site |
|---|---|---|
| `ci.yml` | the Orun pipeline, and the only workflow a site carries: `orun plan --changed`, then one job per lane. A pull request runs the verify lanes (the site built and dry-deployed per environment; they do not lint or run the tests), except the bootstrap's own landings (`orun/BASE-*`), where `plan` alone is the check; a merge deploys stage → prod. It plans nothing while `intent.yaml` names the placeholder workspace `ws_CHANGE_ME`, as this repository does. A manual run (Orunbase's Deploy button, or Run workflow on `main`) plans the environment and components it names under the push-to-main trigger, so they deploy as a merge deploys them | yes |
8 changes: 8 additions & 0 deletions apps/web/.dev.vars.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Local Worker secrets for `wrangler dev` / `opennextjs-cloudflare preview`.
# Copy to .dev.vars (git-ignored). In stage/prod this is a Worker secret, set
# once per environment with
# wrangler secret put WORDPRESS_WEBHOOK_SECRET --name cms-wordpress-web-<env>
# (README → Connecting WordPress); the deploy lane never sets or clears it.
# The WordPress URL is not here: it is inlined at build time (.env.example).
# Optional: without it /api/revalidate refuses every webhook with a 401.
WORDPRESS_WEBHOOK_SECRET=
25 changes: 25 additions & 0 deletions apps/web/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Copy to .env.local (git-ignored) for `next dev` and `pnpm build`.
#
# The WordPress site the pages read, with its REST API at <url>/wp-json/wp/v2.
# A build-time value: `next build` inlines it into the server bundle. A
# deployed build takes it from its environment's WORDPRESS_URL secret
# (README → Connecting WordPress). Unset, the site is not connected: it
# renders its bundled sample posts under a "no WordPress site is connected"
# notice.
WORDPRESS_URL=
# Optional: the template's next/image allow-list for media; the URL's own
# when unset. Inert while images are unoptimised (next.config.ts).
WORDPRESS_HOSTNAME=

# The site's public origin, for absolute links (the sitemap, canonical, Open
# Graph and OG-image links). The deploy sets it per environment.
NEXT_PUBLIC_SITE_URL=

# Read at request time by /api/revalidate (the next-revalidate plugin's
# webhook) — here for `next dev`; on stage and prod a Worker secret, see
# .dev.vars.example. Optional: without it every webhook is refused with 401.
WORDPRESS_WEBHOOK_SECRET=

# Optional. Cloudflare Web Analytics beacon token (stands in for Vercel
# Analytics). Unset → no script is rendered.
NEXT_PUBLIC_CF_BEACON_TOKEN=
21 changes: 21 additions & 0 deletions apps/web/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 9d8

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 30 additions & 0 deletions apps/web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# apps/web — the site

A Next.js front end for a WordPress site used as a headless CMS, from 9d8's
[next-wp](https://github.com/9d8dev/next-wp) (MIT), running on Cloudflare
Workers + Static Assets:

- Posts, pages, categories, tags and authors read from the WordPress REST API
(`/wp-json/wp/v2`) through one typed client, `lib/wordpress.ts`
- `/posts` with search, author, category and tag filters and pagination;
`/posts/[slug]`, `/pages`, `/pages/[slug]`, and the category, tag and
author lists
- The sitemap, Open Graph images (`/api/og`, next/og) and the revalidation
webhook for the next-revalidate plugin (`/api/revalidate`)
- Every page rendered on request against WordPress, shadcn/ui, Tailwind 4,
light and dark themes, Cloudflare Web Analytics (set
`NEXT_PUBLIC_CF_BEACON_TOKEN`)

With no `WORDPRESS_URL` at build time the site is **unconnected**: it renders
the sample content in `lib/sample.ts` under a notice. The site's name is
`SITE_NAME` in `site.config.ts`.

```bash
pnpm dev # next dev on http://localhost:3000
pnpm build # next build + opennextjs-cloudflare build → .open-next/
pnpm preview # wrangler dev over the built Worker
```

How it is connected to a WordPress site and deployed — per environment, on
merge to `main` — is the repository's README and `component.yaml` beside
this file.
78 changes: 78 additions & 0 deletions apps/web/app/api/og/route.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { ImageResponse } from "next/og";
import { NextRequest } from "next/server";

// The Node.js runtime (OpenNext runs no edge functions); next/og renders
// under nodejs_compat.

export async function GET(request: NextRequest) {
try {
const { searchParams } = new URL(request.url);

// Get title and description from the URL query params
const title = searchParams.get("title");
const description = searchParams.get("description");

return new ImageResponse(
(
<div
style={{
height: "100%",
width: "100%",
display: "flex",
flexDirection: "column",
alignItems: "flex-start",
justifyContent: "center",
padding: "80px",
backgroundColor: "white",
backgroundImage:
"radial-gradient(circle at 25px 25px, lightgray 2%, transparent 0%), radial-gradient(circle at 75px 75px, lightgray 2%, transparent 0%)",
backgroundSize: "100px 100px",
}}
>
<div
style={{
display: "flex",
fontSize: 60,
fontStyle: "normal",
color: "black",
marginBottom: 30,
whiteSpace: "pre-wrap",
lineHeight: 1.2,
maxWidth: "800px",
}}
>
{title}
</div>
{description && (
<div
style={{
fontSize: 30,
fontStyle: "normal",
color: "gray",
whiteSpace: "pre-wrap",
lineHeight: 1.2,
maxWidth: "800px",
display: "-webkit-box",
WebkitLineClamp: "2",
WebkitBoxOrient: "vertical",
overflow: "hidden",
textOverflow: "ellipsis",
}}
>
{description}
</div>
)}
</div>
),
{
width: 1200,
height: 630,
}
);
} catch (e) {
console.log(e instanceof Error ? e.message : String(e));
return new Response(`Failed to generate the image`, {
status: 500,
});
}
}
104 changes: 104 additions & 0 deletions apps/web/app/api/revalidate/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
import { revalidatePath, revalidateTag } from "next/cache";
import { NextRequest, NextResponse } from "next/server";

export const maxDuration = 30;

/**
* WordPress webhook handler for content revalidation
* Receives notifications from WordPress when content changes
* and revalidates the entire site
*/

export async function POST(request: NextRequest) {
try {
const requestBody = await request.json();
const secret = request.headers.get("x-webhook-secret");

if (secret !== process.env.WORDPRESS_WEBHOOK_SECRET) {
console.error("Invalid webhook secret");
return NextResponse.json(
{ message: "Invalid webhook secret" },
{ status: 401 }
);
}

const { contentType, contentId } = requestBody;

if (!contentType) {
return NextResponse.json(
{ message: "Missing content type" },
{ status: 400 }
);
}

try {
console.log(
`Revalidating content: ${contentType}${
contentId ? ` (ID: ${contentId})` : ""
}`
);

// Revalidate specific content type tags
revalidateTag("wordpress", { expire: 0 });

if (contentType === "post") {
revalidateTag("posts", { expire: 0 });
if (contentId) {
revalidateTag(`post-${contentId}`, { expire: 0 });
}
// Clear all post pages when any post changes
revalidateTag("posts-page-1", { expire: 0 });
} else if (contentType === "category") {
revalidateTag("categories", { expire: 0 });
if (contentId) {
revalidateTag(`posts-category-${contentId}`, { expire: 0 });
revalidateTag(`category-${contentId}`, { expire: 0 });
}
} else if (contentType === "tag") {
revalidateTag("tags", { expire: 0 });
if (contentId) {
revalidateTag(`posts-tag-${contentId}`, { expire: 0 });
revalidateTag(`tag-${contentId}`, { expire: 0 });
}
} else if (contentType === "author" || contentType === "user") {
revalidateTag("authors", { expire: 0 });
if (contentId) {
revalidateTag(`posts-author-${contentId}`, { expire: 0 });
revalidateTag(`author-${contentId}`, { expire: 0 });
}
}

// Also revalidate the entire layout for safety
revalidatePath("/", "layout");

return NextResponse.json({
revalidated: true,
message: `Revalidated ${contentType}${
contentId ? ` (ID: ${contentId})` : ""
} and related content`,
timestamp: new Date().toISOString(),
});
} catch (error) {
console.error("Error revalidating path:", error);
return NextResponse.json(
{
revalidated: false,
message: "Failed to revalidate site",
error: (error as Error).message,
timestamp: new Date().toISOString(),
},
{ status: 500 }
);
}
} catch (error) {
console.error("Revalidation error:", error);
return NextResponse.json(
{
message: "Error revalidating content",
error: (error as Error).message,
timestamp: new Date().toISOString(),
},
{ status: 500 }
);
}
}
Binary file added apps/web/app/favicon.ico
Binary file not shown.
Loading
Loading