search

JEverhart383 / astro-wordpress-starter

150 stars 31 forks source link

readme

Astro WordPress Starter

This project is meant to be a flexible starting point for people interested in using Astro with WordPress as a headless CMS. If you want some additional resources to help get you started, check out the blog post and video linked below.

✍️ Read the step-by-step tutorial 📹 Watch the video

Requirements

Add a variable to your .env and then hit npm run dev:

WORDPRESS_API_URL = https://yoursitename.com/graphql

Routing and Templates

This starter project leans into the WordPress CMS routing capabilities and uses a getNodeByUri query in WPGraphQL to handle any route path that WordPress knows about. This allows you to handle all WordPress content types using the [...uri].astro component. From there, Astro parses the uri and uses that to call getNodeByURI from api.js to fetch data about that resource from the CMS. Once data is returned, we look at the content type and then dynamically resolve a content template from the templates directory.

Adding Content Types

This project comes with built in support for Post, Page, Tag, and Category types, but could easily be extended for custom post types or other native content types. To add support for a custom post type you would do the following:

  1. Add a GraphQL fragment for your post type to getNodeByURI from api.js
  2. Add an Astro component as a template
  3. Add a case to the switch statement in [...uri].astro to catch the content type and resolve the template

Overriding Default Routing

Since routes using rest parameters in Astro come last in the route priority order, you can easily override this catch-all routing pattern by creating a more specific route to handle a given path.

For example, if you want the path /category/food-trucks to be handled by a different Astro component, you can add a corresponding file to the pages directory to override the default ...uri route.

Menus

By default, the menu assigned to the Primary menu location will be used for your header menu.

Rendering and Serving

This project is using the new hybrid rendering model available in Astro v2. To pre-render any routes you add, make sure to include the following export in your Astro component's frontmatter:

export const prerender = true;

All of the current routes are being pre-rendered to HTML and served using the standalone node adapter. This offers users the flexibility to create additional SSR functionality if desired while still optimizing content pages using pre-rendered HTML.

Headless WordPress Hosting with Atlas

WP Engine's Atlas platform provides a performant and user-friendly hosting platform for headless WordPress and Node-based JavaScript apps. Create a free sandbox account to try the platform, and check out our Astro deployment guide for instruction to deploy to the platform.