Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.8 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.8 KB
Raw

Wordpress Made Easy: Sitebuilder

Getting started with local development

IMPORTANT: First follow the "get started" section of the monorepo.

Prerequisites

  • Docker Desktop (or a local docker installation)
  • pnpm
  • npx
    • npx --version
    • If not found, install with npm install -g npx

Start the local environment

This plugin uses wp-env for local development and testing.

  1. After running pnpm install and pnpm turbo build from the base monorepo directory, you can start the local WordPress environment.
  2. From the plugins/sitebuider folder, run pnpm run env:dev and wait for Docker to complete initializing the site.
  3. Navigate your browser to http://localhost:8888/wp-admin/
    • Username: admin
    • Password: password

Enable BrowserSync

  1. Create a .env file in the root of the project
  2. Add the following value according to your local setup, to the .env file:
MIX_PROXY_URL=sitebuilder-dev.local

Watch project

pnpm run watch

Testing

This plugin uses a combination of Playwright and wp-env to perform automated end-to-end testing in a browser. Before running the testing the first time, you'll need to install the browsers playwright needs.

# To only install Chrome which is used by default
npx playwright install chromium

OR

# To install all browsers (Chrome, Firefox, Webkit)
npx playwright install

Start the local WordPress dev and testing environments

pnpm run env:dev

Run the test suite

pnpm run env:test