Go to file

Sergey Biryukov bd2cd572aa Docs: Improve DocBlocks in `phpunit/includes/object-cache.php` per the documentation standards. See #48303. git-svn-id: https://develop.svn.wordpress.org/trunk@47121 602fd350-edb4-49c9-b593-d223f7449a82		2020-01-29 00:36:17 +00:00
src	Docs: Improve comments in `js/_enqueues/wp/revisions.js` per the documentation standards.	2020-01-29 00:35:39 +00:00
tests	Docs: Improve DocBlocks in `phpunit/includes/object-cache.php` per the documentation standards.	2020-01-29 00:36:17 +00:00
tools	Build Tools: Integrate DependencyExtractionWebpackPlugin in the JS build.	2020-01-03 13:15:33 +00:00
.editorconfig	General: Instruct file editors not to trim trailing whitespace in markdown files.	2018-03-20 22:14:53 +00:00
.env	Docs: Fix typo in `.env` file description.	2019-12-30 13:46:17 +00:00
.gitignore	Build Tools: Integrate DependencyExtractionWebpackPlugin in the JS build.	2020-01-03 13:15: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	Build Tools: Integrate DependencyExtractionWebpackPlugin in the JS build.	2020-01-03 13:15:33 +00:00
README.md	Docs: Fix typo in `README.md`.	2019-11-20 08:31:32 +00:00
SECURITY.md	Security: Add WordPress 5.3.x to the "Supported Versions" section of GitHub Security Policy.	2019-11-16 11:17:42 +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/Test Tools: Pass the `TRAVIS_BRANCH` and `TRAVIS_PULL_REQUEST` environment variables along to the Docker container.	2019-12-20 00:01:33 +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: Update WordPress Packages.	2020-01-22 22:04:35 +00:00
package.json	Block Editor: Update WordPress Packages.	2020-01-22 22:04:35 +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 Tools: Integrate DependencyExtractionWebpackPlugin in the JS build.	2020-01-03 13:15:33 +00:00
phpunit.xml.dist	Tests: Correct the `slowThreshold` option name for `SpeedTrapListener`.	2019-12-11 15:40:57 +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	Docs: Replace Codex URLs with corresponding HelpHub articles in `wp-config-sample.php`.	2019-11-17 11:09:05 +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, 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, 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.