mveer08 / faustjs Goto Github PK

NOTE: This is prerelease software. As we work towards our first release, we will 💯 introduce breaking changes.

Faust.js is a framework for building front-end applications for headless WordPress sites. Faust.js provides tooling to reduce the pains of building a headless WordPress site (namely around data fetching, authentication, previews, and SSR/SSG) while offering a pleasant experience for both developers and publishers.

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:

• Getting started with Next.js

As we work towards our first release, we will be introducing support for other frameworks.

Visit https://faustjs.org/docs/next/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.

📥 Download Latest Version

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

While pull requests are welcome, please note we are in the process of reviewing licensing on the plugin internally and may not be able to merge your pull request in a timely manner.