An open source eCommerce plugin for WordPress.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Roy Ho 59a17b1b56
Deb/assets cleanup (#35748)
2 hours ago
.github Fix/e2e environment test failures (#35679) 6 days ago
.husky Remove the pre-commit husky hook (#34916) 2 months ago
bin Do a checkout of compared branches to ensure prepush checks work (#34706) 2 months ago
packages Align the field height across the whole form (#35720) 3 days ago
plugins Deb/assets cleanup (#35748) 2 hours ago
tools WP-Env: await stopWPEnv so Docker containers can close (#35634) 1 week ago
.codecov.yml chore(ci): add informational Codecov status checks (#32675) 7 months ago
.editorconfig JS formatting files 1 year ago
.eslintignore JS formatting files 1 year ago
.eslintrc.js Designate root level eslint config 12 months ago
.gitignore Add/a2p create customers crud api core tests (#34945) 2 months ago
.npmrc Upgrade to pnpm 7 (#34661) 2 months ago
.nvmrc Update package and node version 12 months ago
.prettierrc.js JS formatting files 1 year ago
.stylelintrc Deprecate stylelint-config-wordpress with current package 12 months ago
.syncpackrc Fix some bugs in syncpack configuration (#35651) 7 days ago
CODE_OF_CONDUCT.md Fixed a typo 6 years ago
DEVELOPMENT.md Replace outdated readme examples of using pnpm (#35064) 2 months ago
README.md Restore 'Contributing to WooCommerce' guidance (#34380) 3 months ago
SECURITY.md Removed the reference to WP mobile apps. 2 years ago
changelog.txt Update changelog.txt from release 7.1.0 (#35524) 3 weeks ago
package.json Fix some bugs in syncpack configuration (#35651) 7 days ago
phpcs.xml Make Yoda conditions mandatory again (#34335) 3 months ago
pnpm-lock.yaml Fix/e2e environment test failures (#35679) 6 days ago
pnpm-workspace.yaml Storybook: Fix after update to PNPM 7 broke build (#34724) 2 months ago
renovate.json Converted Spaces To Tabs In JSON 7 months ago
tsconfig.base.json Removed `@woocommerce/notices` Internal Prefix (#33283) 6 months ago
turbo.json Revert "Add pre build script to delete assets" (#35693) 5 days ago

README.md

WooCommerce

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 to follow the WooCommerce development blog to stay up to date about everything happening in the project. You can also follow @DevelopWC on 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 .nvmrc file 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.2+: WooCommerce Core currently features a minimum PHP version of 7.2. It is also needed to run Composer and various project build scripts.
  • Composer: We use Composer to manage all of the dependencies for PHP packages and plugins.

Once you've installed all of the prerequisites, you can run the following commands to get everything working.

# Ensure that you're using the correct version of Node
nvm use
# Install the PHP and Composer dependencies for all of the plugins, packages, and tools
pnpm install
# Build all of the plugins, packages, and tools in the monorepo
pnpm run build

At this point you are now ready to begin developing and testing. All of the build outputs are cached running pnpm run build again will only build the plugins, packages, and tools that have changed since the last time you ran the command.

Check out our development guide if you would like a more comprehensive look at working in our repository.

Repository Structure

  • Plugins: Our repository contains plugins that relate to or otherwise aid in the development of WooCommerce.
    • WooCommerce Core: The core WooCommerce plugin is available in the plugins directory.
  • Packages: Contained within the packages directory are all of the PHP and JavaScript provided for the community. Some of these are internal dependencies and are marked with an internal- prefix.
  • Tools: We also have a growing number of tools within our repository. Many of these are intended to be utilities and scripts for use in the monorepo, but, this directory may also contain external tools.

Reporting Security Issues

To disclose a security issue to our team, please submit a report via HackerOne here.

Support

This repository is not suitable for support. Please don't use our issue tracker for support requests, but for core WooCommerce issues only. Support can take place through the appropriate channels:

Support requests in issues on this repository will be closed on sight.

Contributing to WooCommerce

If you have a patch or have stumbled upon an issue with WooCommerce core, you can contribute this back to the code. Please read our contributor guidelines for more information on how you can do this.