README
WooCommerce Monorepo
Welcome to the WooCommerce monorepo on GitHub. Here you can find all of the plugins, packages, and tools used in the development of the core WooCommerce plugin as well as WooCommerce extensions. You can browse the source, look at open issues, contribute code, and keep tracking of ongoing development.
We recommend all developers follow the WooCommerce development blog to stay up to date with everything happening in the project. You can also follow @DevelopWoo on X (formerly Twitter) for the latest development updates.
Getting Started
To get up and running within the WooCommerce Monorepo, you will need to make sure that you have installed all of the prerequisites.
Prerequisites
- NVM: While you can always install Node through other means, we recommend using NVM to ensure you're aligned with the version used by our development teams. Our repository contains an
.nvmrcfile which helps ensure you are using the correct version of Node. - PNPM: Our repository utilizes PNPM to manage project dependencies and run various scripts involved in building and testing projects.
- PHP 7.4+: WooCommerce Core currently requires PHP version 7.4 or higher. It is also needed to run Composer and various project build scripts. See troubleshooting for troubleshooting problems installing PHP.
- Composer: We use Composer to manage all of the dependencies for PHP packages and plugins.
Note: A POSIX-compliant operating system (e.g., Linux, macOS) is assumed. If you're working on a Windows machine, the recommended approach is to use WSL (available since Windows 10).
Once you've installed all prerequisites, the following will prepare all of the build outputs necessary for development:
# Ensure that the correct version of Node is installed and being used
nvm install
# Install the PHP and Composer dependencies for all of the plugins, packages, and tools
pnpm install -frozen-lockfile
# Build all of the plugins, packages, and tools in the monorepo
pnpm build