Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 2.68 KB

README.md

File metadata and controls

44 lines (36 loc) · 2.68 KB
Raw

AxePress Labs - Playground 🧪

AxePress Labs - Playground is an example Next.JS app that uses WPGraphQL and Faust.js to experiment with headless WordPress patterns.

⚠️ Code in this repository is highly experimental and subject to change. It should be used for inspiration and educational purposes only. DO NOT RUN ON PRODUCTION⚠️

Feature Demos

Prerequisites

What's Included

  • A Next.JS app that uses Faust.js to fetch data WPGraphQL.
  • TypeScript linting and hinting with graphql-codegen. (Note: there are still some type errors so strict is false in tsconfig.json for now).
  • ESLint rules configured for WordPress Coding Standards.
  • Advanced developer logging of ApolloClient queries and mutations.
  • WP Template Hierarchy support with Faust.js's wp-templates.
  • Site Editor support (experimental) for Headers, Footers, and content.
  • A better DefaultBlock that doesn't rely on dangerouslySetInnerHTML.
  • TailwindCSS for when the globalStylesheet and block styles aren't enough.
  • SEO support using Rank Math SEO and next-seo.
  • RSS Feeds ( in case any @wpengine DevRel peeps are looking 😜 ).
  • PWA support with next-pwa.
  • External script support with partytown.

Getting Started

  • Run npm install or yarn install to install dependencies.
  • Copy .env.example to .env and update the values to match your environment. (See Faust.js Getting started).
  • Copy the Block Theme style.css file to the project. (How to)
  • Update tailwind.config.js to match your theme's colors, and apply any overrides you need in src/styles/overrides.css.
  • Run npm run dev or yarn dev to start the development server. (This will run yarn prepare which generates the types from GraphQL).
  • Start developing!