{"id":27852847,"url":"https://github.com/wpengine/headless-framework","last_synced_at":"2025-05-04T06:01:11.132Z","repository":{"id":37075171,"uuid":"313420182","full_name":"wpengine/faustjs","owner":"wpengine","description":"Faust.js™ - The Headless WordPress Framework","archived":false,"fork":false,"pushed_at":"2025-04-25T13:40:39.000Z","size":49268,"stargazers_count":1478,"open_issues_count":47,"forks_count":146,"subscribers_count":88,"default_branch":"canary","last_synced_at":"2025-04-25T17:53:52.573Z","etag":null,"topics":["composable-architecture","hacktoberfest","headless","headless-cms","headless-wordpress","javascript","nextjs","react","wordpress"],"latest_commit_sha":null,"homepage":"https://faustjs.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wpengine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":"audit-ci.jsonc","citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-16T20:33:30.000Z","updated_at":"2025-04-24T23:00:15.000Z","dependencies_parsed_at":"2023-10-13T01:25:44.000Z","dependency_job_id":"6b5d0910-1d1e-45d0-8a6e-ac3c7e36cd50","html_url":"https://github.com/wpengine/faustjs","commit_stats":{"total_commits":1277,"total_committers":53,"mean_commits":24.09433962264151,"dds":0.754894283476899,"last_synced_commit":"901149222ba1bac45d8018a509bcd43114228a52"},"previous_names":["wpengine/headless-framework"],"tags_count":259,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Ffaustjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Ffaustjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Ffaustjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wpengine%2Ffaustjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wpengine","download_url":"https://codeload.github.com/wpengine/faustjs/tar.gz/refs/heads/canary","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252294743,"owners_count":21724965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composable-architecture","hacktoberfest","headless","headless-cms","headless-wordpress","javascript","nextjs","react","wordpress"],"created_at":"2025-05-04T06:00:44.712Z","updated_at":"2025-05-04T06:01:10.970Z","avatar_url":"https://github.com/wpengine.png","language":"TypeScript","readme":"![Faust.js](https://user-images.githubusercontent.com/5306336/152221545-53087444-b3ad-477d-90a9-606785854656.jpg)\n\n\u003cp align=\"center\"\u003e\n  \u003ca aria-label=\"@faustwp/core Downloads\" href=\"https://www.npmjs.com/package/@faustwp/core\"\u003e\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/dw/@faustwp/core?color=7e5cef\u0026style=for-the-badge\u0026label=@faustwp/core\"\u003e\n  \u003c/a\u003e\n\u003c!--  --\u003e\n  \u003ca aria-label=\"@faustwp/cli Downloads\" href=\"https://www.npmjs.com/package/@faustwp/cli\"\u003e\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/dw/@faustwp/cli?color=7e5cef\u0026style=for-the-badge\u0026label=@faustwp/cli\"\u003e\n  \u003c/a\u003e\n\u003c!--  --\u003e\n  \u003ca aria-label=\"License\" href=\"https://github.com/wpengine/faustjs/blob/canary/LICENSE\"\u003e\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/l/@faustjs/core?color=7e5cef\u0026style=for-the-badge\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Introduction\n\nFaust.js is a toolkit for building Next.js 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.\n\n- [Getting started with Next.js](https://faustjs.org/docs/getting-started)\n\n## System Requirements\n\n- Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13 and v18.17 when using Next.js 14).\n- MacOS, Windows (including WSL), and Linux are supported.\n\n## Documentation\n\nVisit [https://faustjs.org/docs/](https://faustjs.org/docs/getting-started) to view the full documentation.\n\n### Editing Docs\n\nDocs are MD in [`docs`](docs/). Here are a couple things you should know!\n\n1.  Our Docs support [Github Flavored Markdown](https://github.github.com/gfm/) (GFM).\n2.  Images should be stored along side the doc that uses them in an `images/` folder.\n3.  Shared Images can be stored in a shared folder @ `docs/images`\n4.  [Callouts](https://github.com/lin-stephanie/rehype-callouts?tab=readme-ov-file#rehype-callouts): These are similar to block quotes or an aside but for various warnings, info, pro times, etc.\n5.  Code Blocks:\n\n    - Required\n      1. Specify a language: ` ```js ` or `` `const inlineCode = [1,2,3];{:js}` ``\n         - Commands for a users terminal = `bash`\n         - env files = `ini`\n         - JavaScript = `js`\n         - TypeScript = `ts`\n         - GraphQL = `gql`\n         - JSON = `json`\n         - For a full list see: https://shiki.style/languages\n      2. Add [line numbers](https://rehype-pretty.pages.dev/#line-numbers) to any complex code. `ini` and `bash` don't need to show line numbers generally. ` ```js showLineNumbers`\n      3. Complete files should have a [file names](https://rehype-pretty.pages.dev/#titles) ` ```js title=\"pages/_app.js`\n    - Optional\n\n      1.  Lines can be [highlighted](https://rehype-pretty.pages.dev/#highlight-lines) in code blocks ` ```js {1,3-5}`. There are a variety of advanced highlighting methods, see: https://rehype-pretty.pages.dev/#highlight-lines\n      2.  Lines may be [diffed](https://shiki.style/packages/transformers#transformernotationdiff) in a code block:\n\n\t\t\t```js\n\t\t\tconsole.log('hewwo') // [!code --]\n\t\t\tconsole.log('hello') // [!code ++]\n\t\t\tconsole.log('goodbye')\n\t\t\t```\n\n## WordPress Plugin (FaustWP)\n\nThere 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.\n\nYou can download and install FaustWP from the [WordPress Plugin Directory](https://wordpress.org/plugins/faustwp/), or by using the zip linked below.\n\n[📥 Download Latest Version](https://wordpress.org/plugins/faustwp/)\n\n## Community\n\nTo chat with other Faust.js users and the headless community as a whole, you can join the [WP Engine Developers Discord](https://discord.gg/J2khkF9XYK).\n\nAdditionally, if you have questions or ideas, please share them on [GitHub Discussions](https://github.com/wpengine/faustjs/discussions).\n\n## Contributing\n\nThere are many ways to [contribute](/CONTRIBUTING.md) to this project.\n\n- [Discuss open issues](https://github.com/wpengine/faustjs/issues) to help define the future of the project.\n- [Submit bugs](https://github.com/wpengine/faustjs/issues) and help us verify fixes as they are checked in.\n- Review and discuss the [source code changes](https://github.com/wpengine/faustjs/pulls).\n- [Contribute bug fixes](/CONTRIBUTING.md)\n\n### Contributor License Agreement\n\nAll 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.\n\n1. [Submit your name and email](https://wpeng.in/cla/)\n2. 📝 Sign the CLA emailed to you\n3. 📥 Receive copy of signed CLA\n\n❤️ Thank you for helping us fulfill our legal obligations in order to continue empowering builders through headless WordPress.\n","funding_links":[],"categories":["Frontend"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpengine%2Fheadless-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwpengine%2Fheadless-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpengine%2Fheadless-framework/lists"}