Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.92 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.92 KB
Raw

Performance Lab

Performance Lab plugin banner with icon

Monorepo for the WordPress Performance Group, primarily for the Performance Lab plugin, which is a collection of standalone performance modules.

Learn more about the Performance Lab plugin.

Quick Start

To get started with contributing to the Performance Lab project:

  1. Fork the repository.
  2. Clone the fork locally.
  3. Run composer install in the project folder.
  4. Run npm install in the project folder.
  5. Start the development environment by running npm run wp-env start.
  6. Go to http://localhost:8888/wp-admin/ in your browser.
  7. Log in using admin and password.

See the section below for more details on how the environment works.
More details about getting started here.

Useful commands

In order to run the following commands, you need to have Node.js (including npm) and Docker installed, and Docker needs to be up and running. The Docker configuration used relies on the @wordpress/env package.

  • npm install: Installs local development dependencies.
  • npm run wp-env start: Starts the local development environment.
  • npm run wp-env stop: Stops the local development environment.
  • npm run lint-php: Lints all PHP code.
  • npm run format-php: Formats all PHP code.
  • npm run test-php: Runs PHPUnit tests for all PHP code.
  • npm run test-php-multisite: Runs PHPUnit tests in multisite for all PHP code.

Documentation

See the /docs folder for documentation.