diff options
| author | Gary Pendergast <pento@git.wordpress.org> | 2019-08-05 07:09:14 +0000 |
|---|---|---|
| committer | Gary Pendergast <pento@git.wordpress.org> | 2019-08-05 07:09:14 +0000 |
| commit | 82d7870fe45bc4b5c20150b0041f9e4ae23e574b (patch) | |
| tree | 856e5fe571b31f2acb6201be3d9e1e7c5dba4dfa /README.md | |
| parent | 3705fddde7b2dff6924ab8434de2eb3a5ec59399 (diff) | |
| download | wordpress-82d7870fe45bc4b5c20150b0041f9e4ae23e574b.tar.gz wordpress-82d7870fe45bc4b5c20150b0041f9e4ae23e574b.zip | |
Build Tools: Add a WordPress Development Environment.
This commit adds the first iteration of a Docker-based config for setting up a local WordPress development environment.
Props pento, noisysocks, mcsf, pbearne, isabel_brison.
See #47767.
git-svn-id: https://develop.svn.wordpress.org/trunk@45745 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000000..3072060155 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# WordPress + +[](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, documention, 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: + +### Development Environment Commands + +Running these commands will start the development environment: + +``` +npm install +npm run build:dev +npm run env:start +npm run env:install +``` + +Additionally, `npm run env:stop` will stop the environment. + +`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`. + +`npm run test:php` and `npm run test:e2e` run the PHP and E2E test suites, respectively. |