Make WordPress Core

Changeset 47743


Ignore:
Timestamp:
05/02/2020 07:14:24 PM (4 years ago)
Author:
johnbillion
Message:

Build/Test Tools: Add more comprehensive instructions to the readme for the local development environment.

See #50058

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README.md

    r46752 r47743  
    33[![Build Status](https://img.shields.io/travis/com/WordPress/wordpress-develop/master.svg)](https://travis-ci.com/WordPress/wordpress-develop)
    44
    5 Welcome to the WordPress development repository! Please check out our [contributor handbook](https://make.wordpress.org/core/handbook/) for information about how to open bug reports, contribute patches, test, documentation, or get involved in any way you can.
     5Welcome to the WordPress development repository! Please check out the [contributor handbook](https://make.wordpress.org/core/handbook/) for information about how to open bug reports, contribute patches, test changes, write documentation, or get involved in any way you can.
    66
    77## Getting Started
    88
    9 WordPress is a PHP/MySQL-based project. We have a basic development environment that you can quickly get up and running with a few commands. First off, you will need to download and install [Docker](https://www.docker.com/products/docker-desktop), if you don't have it already. After that, there are a few commands to run:
     9WordPress is a PHP, MySQL, and JavaScript based project, and uses uses Node for its JavaScript dependencies. A local development environment is available to quickly get up and running.
     10
     11You will need a basic understanding of how to use the command line on your computer. This will allow you to set up the local development environment, to start it and stop it when necessary, and to run the tests.
     12
     13You will need [Docker](https://www.docker.com/products/docker-desktop) installed and running on your computer. Docker is the virtualization software that powers the local development environment.
    1014
    1115### Development Environment Commands
    1216
    13 Running these commands will start the development environment:
     17Ensure [Docker](https://www.docker.com/products/docker-desktop) is running before using these commands.
     18
     19#### To start the development environment for the first time
    1420
    1521```
     
    2026```
    2127
    22 Additionally, `npm run env:stop` will stop the environment.
     28The environment will be accessible at http://localhost:8889.
    2329
    24 `npm run env:cli` runs the [WP-CLI tool](https://make.wordpress.org/cli/handbook/). WP-CLI has a lot of [useful commands](https://developer.wordpress.org/cli/commands/) you can use to work on your WordPress site. Where the documentation mentions running `wp`, run `npm run env:cli` instead. For example, `npm run env:cli help`.
     30#### To watch for changes
    2531
    26 `npm run test:php` and `npm run test:e2e` run the PHP and E2E test suites, respectively.
     32If you're making changes to WordPress core files, you should start the file watcher in order to build or copy the files as necessary:
     33
     34```
     35npm run watch
     36```
     37
     38To stop the watcher, press `ctrl+c`.
     39
     40#### To run a [WP-CLI](https://make.wordpress.org/cli/handbook/) command
     41
     42```
     43npm run env:cli <command>
     44```
     45
     46WP-CLI has a lot of [useful commands](https://developer.wordpress.org/cli/commands/) you can use to work on your WordPress site. Where the documentation mentions running `wp`, run `npm run env:cli` instead. For example:
     47
     48```
     49npm run env:cli help
     50```
     51
     52#### To run the tests
     53
     54These commands run the PHP and end-to-end test suites, respectively:
     55
     56```
     57npm run test:php
     58npm run test:e2e
     59```
     60
     61#### To stop the development environment
     62
     63You can stop the environment when you're not using it to preserve your computer's power and resources:
     64
     65```
     66npm run env:stop
     67```
     68
     69#### To start the development environment again
     70
     71Restarting the environment again is a single command:
     72
     73```
     74npm run env:start
     75```
Note: See TracChangeset for help on using the changeset viewer.