WordPress.org

Make WordPress Core

Changeset 47752 for trunk


Ignore:
Timestamp:
05/03/2020 02:41:03 PM (6 months ago)
Author:
johnbillion
Message:

Build/Test Tools: Further enhancements to the local development environment readme.

Props desrosj, donmhico

See #50058

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README.md

    r47744 r47752  
    1010## Getting Started
    1111
    12 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.
     12WordPress is a PHP, MySQL, and JavaScript based project, and uses Node for its JavaScript dependencies. A local development environment is available to quickly get up and running.
    1313
    1414You 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.
    1515
    16 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.
     16You will need Node and npm installed on your computer. Node is a JavaScript runtime used for developer tooling, and npm is the package manager included with Node. If you have a package manager installed for your operating system, setup can be as straightforward as:
     17
     18* macOS: `brew install node`
     19* Windows: `choco install node`
     20* Ubuntu: `apt install nodejs npm`
     21
     22If you are not using a package manager, see the [Node.js download page](https://nodejs.org/en/download/) for installers and binaries.
     23
     24You will also 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. Docker can be installed just like any other regular application.
    1725
    1826### Development Environment Commands
     
    2937```
    3038
    31 The environment will be accessible at http://localhost:8889.
     39Your WordPress site will accessible at http://localhost:8889. You can see or change configurations in the `.env` file located at the root of the project directory.
    3240
    3341#### To watch for changes
     
    6270```
    6371
     72#### To restart the development environment
     73
     74You may want to restart the environment if you've made changes to the configuration in the `docker-compose.yml` or `.env` files. Restart the environment with:
     75
     76```
     77npm run env:restart
     78```
     79
    6480#### To stop the development environment
    6581
     
    7288#### To start the development environment again
    7389
    74 Restarting the environment again is a single command:
     90Starting the environment again is a single command:
    7591
    7692```
Note: See TracChangeset for help on using the changeset viewer.