sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

See #50058

git-svn-id: https://develop.svn.wordpress.org/trunk@47743 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2020-05-02 19:14:24 +00:00
parent 578956abf6
commit b9f6cf083a
1 changed files with 55 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -2,15 +2,21 @@
[![Build Status](https://img.shields.io/travis/com/WordPress/wordpress-develop/master.svg)](https://travis-ci.com/WordPress/wordpress-develop)
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.
Welcome 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.
## Getting Started
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:
WordPress 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.
You 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.
You 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.
### Development Environment Commands
Running these commands will start the development environment:
Ensure [Docker](https://www.docker.com/products/docker-desktop) is running before using these commands.
#### To start the development environment for the first time
```
npm install
@ -19,8 +25,51 @@ npm run env:start
npm run env:install
```
Additionally, `npm run env:stop` will stop the environment.
The environment will be accessible at http://localhost:8889.
`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`.
#### To watch for changes
`npm run test:php` and `npm run test:e2e` run the PHP and E2E test suites, respectively.
If you're making changes to WordPress core files, you should start the file watcher in order to build or copy the files as necessary:
```
npm run watch
```
To stop the watcher, press `ctrl+c`.
#### To run a [WP-CLI](https://make.wordpress.org/cli/handbook/) command
```
npm run env:cli <command>
```
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
```
#### To run the tests
These commands run the PHP and end-to-end test suites, respectively:
```
npm run test:php
npm run test:e2e
```
#### To stop the development environment
You can stop the environment when you're not using it to preserve your computer's power and resources:
```
npm run env:stop
```
#### To start the development environment again
Restarting the environment again is a single command:
```
npm run env:start
```