Go to file

John Blackbourn afecdb29c5 Block Editor: Bug fixes targeted for WordPress 5.3 RC4. Merges [46656] to the 5.3 branch. Fixes #48502 git-svn-id: https://develop.svn.wordpress.org/trunk@46663 602fd350-edb4-49c9-b593-d223f7449a82		2019-11-05 21:51:30 +00:00
src	Block Editor: Bug fixes targeted for WordPress 5.3 RC4.	2019-11-05 21:51:30 +00:00
tests	REST API: Speed up pagination unit tests by creating less fixtures and reusing them where possible.	2019-11-05 20:41:12 +00:00
tools	Block Editor: Remove experimental Social Links blocks	2019-10-15 15:35:03 +00:00
.editorconfig	General: Instruct file editors not to trim trailing whitespace in markdown files.	2018-03-20 22:14:53 +00:00
.env	Build Tools: Miscellaneous `local-env` improvements.	2019-08-12 08:28:33 +00:00
.gitignore	Build Tools: Miscellaneous `local-env` improvements.	2019-08-12 08:28:33 +00:00
.jshintrc	Build tools: Fix the `travis:js` build.	2018-12-24 13:53:11 +00:00
.npmrc	Once upon a midnight dreary, while I coded, weak and weary,	2018-05-23 10:04:22 +00:00
.nvmrc	Once upon a midnight dreary, while I coded, weak and weary,	2018-05-23 10:04:22 +00:00
.travis.yml	Build/Test Tools: Don't hardcode the directory name of the repo	2019-10-28 04:15:37 +00:00
Gruntfile.js	External Libraries: Revert [46634-46635].	2019-11-03 17:07:42 +00:00
README.md	Build Tools: Add a WordPress Development Environment.	2019-08-05 07:09:14 +00:00
appveyor.yml	Build/Test Tools: Remove the dependency on a globally installed Grunt.	2019-05-26 19:34:24 +00:00
composer.json	Build/Test Tools: Move Composer script command line directives to the PHPCS ruleset.	2019-09-25 14:01:51 +00:00
composer.lock	Build/Test Tools: Introduce automated PHP compatibility checking.	2019-09-25 13:46:55 +00:00
docker-compose.yml	Build Tools: Pass the current uid/gid to Docker containers.	2019-09-26 04:57:38 +00:00
jsdoc.conf.json	Build Tools: Fix JSDoc configuration include paths.	2018-06-14 12:45:06 +00:00
package-lock.json	Block Editor: Bug fixes targeted for WordPress 5.3 RC4.	2019-11-05 21:51:30 +00:00
package.json	Block Editor: Bug fixes targeted for WordPress 5.3 RC4.	2019-11-05 21:51:30 +00:00
phpcompat.xml.dist	Build/Test Tools: Introduce automated PHP compatibility checking.	2019-09-25 13:46:55 +00:00
phpcs.xml.dist	Build/Test Tools: Move Composer script command line directives to the PHPCS ruleset.	2019-09-25 14:01:51 +00:00
phpunit.xml.dist	Ensure `svn:eol-style` is consistently set for all files (part 2).	2019-10-25 19:27:49 +00:00
webpack.config.js	Build tools: Allow building WordPress to `src`.	2018-12-24 13:28:22 +00:00
wp-cli.yml	Build/Tests: Default to running unit tests from `src`.	2019-01-09 10:09:02 +00:00
wp-config-sample.php	Add `svn:auto-props` for `eol-style` and `mime-type` to `trunk`.	2019-11-03 16:19:15 +00:00
wp-tests-config-sample.php	Tests: Revert [44509].	2019-01-09 11:13:03 +00:00

README.md

WordPress

Welcome to the WordPress development repository! Please check out our contributor 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, 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. WP-CLI has a lot of useful 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.