Skip to content

WordPress/wporg-developer

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2a00d57 · Nov 6, 2023
Apr 4, 2023
Jan 12, 2023
Nov 6, 2023
Jun 6, 2022
Jan 12, 2023
May 24, 2022
Sep 15, 2023
Oct 26, 2023
Oct 30, 2023
May 31, 2022
Jan 12, 2023
Jan 12, 2023
Jan 12, 2023

Repository files navigation

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