Skip to content

A codespace starter kit for WordPress theme and plugin development.

Notifications You must be signed in to change notification settings

codeispoetry/wp-codespace

Repository files navigation

WordPress Codespace Dev Environment

This is a starter kit for a development environment for WordPress in a GitGub Codepsace. Start developing for WordPress right after a single click.

Usage

Create your own codespace by clicking this button. Please allow 5 minutes for auto-configuration at first setup.

Open in GitHub Codespaces

Try the example plugin in plugins/wp-codespace, make some changes and appreciate the advantages of a pre-configured codespace.

Behind the scenes

This setup will install and configure the following things automatically:

  • WordPress with credentials admin/admin
  • install and activate selected plugins
  • WP CLI
  • node (npm) and php (composer) dependencies
  • add playwright test environment
  • configure in VS Code:
    • WP Coding Standards
    • autocompletion for WordPress functions
    • searchable WordPress-Docs

For more details, see .devcontainer.json, Dockerfile and postCreateCommand.sh, all of which you will find in the .devcontainer-folder.

About Codepsaces

GitHub Codespaces are your dev environment in the cloud. Start coding instantly on your WordPress theme or plugin. A codespace is an IDE in the browser with pre-configured XDebug, WordPress Coding Standards and a pre-installed WordPress with your personal plugin or theme, that you are developing.

Set up your personal codespace on this repo (or on your private fork) with just one click. Codespace installs WordPress automatically, pre-configures XDebug, enables playwright tests, installs the WordPress Coding Standards and configures the VS Code extension for PHP_CodeSniffer and many other WordPress extensions. Start coding your theme or plugin without any further ado.

A codespace is a convenient way to contribute to an Open Source project, as you find all prerequisites preconfigured. You do not have to install any software, a codespace runs in the browser, as well as in your local VS Code or PhpStorm.

Just type, test and refactor your WordPress code. No need for DevOps.

Give it a try and create your personal codespace on main right now.