This repository contains a starter kit to get you up and running quickly on WP Engine's Headless Platform with a WordPress site skeleton for more advanced developers.
To get started on WP Engine's Platform please follow the docs here https://developers.wpengine.com/docs/atlas/getting-started/create-app/
├── src/
│ ├── __generated__/
│ ├── components/
│ ├── fragments/
│ ├── pages/
│ ├── queries/
│ ├── styles/
│ └── wp-templates/
├── DEVELOPMENT.md
├── faust.config.js
├── next.config.js
├── package.json
├── possibleTypes.json
└── README.md
└── screenshots
| Command | Script | Description |
|---|---|---|
dev |
npm run generate && concurrently "faust dev" "npm run watch-codegen" |
Start dev server and watch codegen |
build |
faust build |
Build the project for production |
generate |
faust generatePossibleTypes |
Generate GraphQL possible types |
start |
faust start |
Start the production server |
codegen |
graphql-codegen |
Run GraphQL code generation |
watch-codegen |
graphql-codegen -w |
Watch and auto-run GraphQL codegen |
format |
prettier . --write |
Format code with Prettier |
test:format |
prettier . --check |
Check code formatting |
View Screenshots
At WP Engine, we have a strong community built around headless WordPress to support you with your journey.
- Discord Headless Community Channel
- Fortnightly Headless Community Call
- WP Engine's Headless Platform developer community
- WP Engine`s Builders YouTube Channel
- WP Engine's Headless Platform
- WP Engines Headless Platform Docs
Note
We are continuously adding new docs for Faustjs.org
All external contributors to WP Engine products must have a signed Contributor License Agreement (CLA) in place before the contribution may be accepted into any WP Engine codebase.
- Submit your name and email
- 📝 Sign the CLA emailed to you
- 📥 Receive copy of signed CLA
❤️ Thank you for helping us fulfill our legal obligations in order to continue empowering builders through headless WordPress.