Skip to content

Conversation

@josephfusco
Copy link
Member

@josephfusco josephfusco commented Nov 20, 2025

This pull request updates the Faust.js tutorial example to use wp-env with Docker for managing the WordPress backend instead of the previous wp-now approach. It introduces new configuration and setup files, updates documentation, and removes obsolete files to streamline the developer experience. The most important changes are grouped below:

Migration to wp-env and Docker-based WordPress setup:

  • Added .wp-env.json configuration to specify plugins, PHP version, mappings, and lifecycle scripts for the WordPress environment.
  • Added wp-env/setup/.htaccess to enable CORS headers and provide WordPress rewrite rules for the Docker-based environment.
  • Updated all documentation and environment files to use port 8888 for WordPress instead of 8881, reflecting the new setup. [1] [2] [3] [4] [5] [6]

Project initialization and documentation improvements:

  • Added a comprehensive README.md with prerequisites, step-by-step quick start instructions, command reference, and project structure overview.
  • Added a complete package.json with scripts for managing the tutorial and WordPress environment, dependencies, and overrides.

Cleanup of obsolete files:

  • Removed the old faust-tutorial-blueprint.json used by wp-now, as it is no longer needed with the new wp-env workflow.

Fixes #2211

Added .wp-env.json and supporting wp-env files for improved local WordPress setup. Updated README with detailed setup instructions and commands. Changed default WordPress port in .env.local.example. Removed obsolete faust-tutorial-blueprint.json. Updated dependencies in package.json and package-lock.json. Improved tutorial documentation in docs/tutorial/learn-faust/index.md.
@josephfusco josephfusco requested a review from a team as a code owner November 20, 2025 15:38
@changeset-bot
Copy link

changeset-bot bot commented Nov 20, 2025

⚠️ No Changeset found

Latest commit: 895e189

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@josephfusco josephfusco enabled auto-merge (squash) November 20, 2025 15:38
@github-actions
Copy link
Contributor

github-actions bot commented Nov 20, 2025

📦 Next.js Bundle Analysis for @faustwp/getting-started-example

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@colinmurphy
Copy link
Member

Note

For testing as it is not merged, you need to use

npx degit wpengine/faustjs/examples/next/tutorial#issue-2211 faust-tutorial

@josephfusco
Copy link
Member Author

closing in favor of #2221

auto-merge was automatically disabled November 20, 2025 19:40

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Faust Tutorial

3 participants