Ichabod is WebDevStudios' headless framework, based on the powerful Faust.js framework built by WPEngine. Ichabod has the same tooling and features of Faust.js, but augmented with the build scripts, code checking, and other amazing features that make building with WordPress a breeze at WebDevStudios.
Note: some documentation from Faust.js is preserved for legacy and instructional reason. The original Faust name will be kept in this documentation to alleviate confusion.
Run the following command:
npx create-next-app \
-e https://github.com/WebDevStudios/wds-ichabodjs/tree/prod \
--example-path examples/next/faustwp-getting-started \
--use-npm
Now that the project is created, cd into your new app folder. For example, if you named your project MyProject:
cd MyProject
Once inside your project folder root, copy the sample .env.local.sample file and create a new one called .env.local:
cp .env.local.sample .env.local
We will update the .env.local variables shortly. But for now, run the local development server:
npm run dev
Once the development environment is up and running, navigate to http://localhost:3000 in your browser to view it.
Currently, the posts and pages you see are coming from the WordPress site at https://faustexample.wpengine.com.
Faust.js aims to be framework agnostic, so it can be used with any front-end framework. Visit one of the guides below for a starting point:
As we work towards our first release, we will be introducing support for other frameworks.
- Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13 and v18.17 when using Next.js 14).
- MacOS, Windows (including WSL), and Linux are supported.
Visit https://faustjs.org/docs/getting-started to view the full documentation.
There are two key parts to Faust.js: the NPM packages and the WordPress plugin. To take full advantage of headless, you will need to install the plugin in addition to the npm packages.
You can download and install FaustWP from the WordPress Plugin Directory, or by using the zip linked below.
To chat with other Faust.js users and the headless community as a whole, you can join the WP Engine Developers Discord.
Additionally, if you have questions or ideas, please share them on GitHub Discussions.
There are many ways to contribute to this project.
- Discuss open issues to help define the future of the project.
- Submit bugs and help us verify fixes as they are checked in.
- Review and discuss the source code changes.
- Contribute bug fixes
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.