/wporg-developer

WordPress.org Developer theme

Primary LanguagePHP

Developer.WordPress.org Theme

Development

Prerequisites

  • Docker
  • Node/npm
  • Yarn
  • Composer

Setup

  1. Set up repo dependencies.

    yarn setup:tools
  2. Build the assets. If there's anything that needs setting up.

    yarn build
  3. Start the local environment.

    yarn wp-env start
  4. Run the setup script.

    yarn setup
  5. Visit site at localhost:8888.

  6. Log in with username admin and password password.

Environment management

These must be run in the project's root folder, not in theme/plugin subfolders.

  • Stop the environment.

    yarn wp-env stop
  • Restart the environment.

    yarn wp-env start
  • Open a shell inside the docker container.

    yarn wp-env run wordpress bash
  • Run wp-cli commands. Keep the wp-cli command in quotes so that the flags are passed correctly.

    yarn wp-env run cli "post list --post_status=publish"
  • Update composer dependencies and sync any repo-tools changes.

    yarn update:tools
  • Watch for SCSS changes and rebuild the CSS as needed.

    yarn start:theme
  • Parse the code reference again. This is run as part of the project setup.

    yarn parse

Asset management

  • Build assets once: yarn build:theme
  • Watch assets and build on changes: yarn start:theme