A customizable, open-source ecommerce platform built on WordPress. Build any commerce solution you can imagine.
Go to file
Kaavya a9b0542532
Fix/33253 fix order number in notice (#33802)
Fix order number displayed in order status changed notice
2022-08-02 10:02:15 -07:00
.github Add cherry pick workflow (#34157) 2022-08-02 08:14:58 -07:00
.husky Migrate From Nx to Turborepo (#33079) 2022-06-09 14:40:07 -07:00
.vscode tsconfig modifications 2022-03-29 16:08:07 +08:00
bin Add changelog validation to pre push (#33976) 2022-07-20 06:09:48 -07:00
packages add: store location settings tour (#34137) 2022-08-02 11:10:34 +08:00
plugins Fix/33253 fix order number in notice (#33802) 2022-08-02 10:02:15 -07:00
tools Packages Release: Add manual workflow (#33922) 2022-07-22 12:08:11 +12:00
.codecov.yml chore(ci): add informational Codecov status checks (#32675) 2022-04-26 10:20:59 +12:00
.editorconfig JS formatting files 2021-10-19 10:35:46 +13:00
.eslintignore JS formatting files 2021-10-19 10:35:46 +13:00
.eslintrc.js Designate root level eslint config 2021-12-13 08:13:40 -08:00
.gitignore Add JSON report output to PW tests (#34057) 2022-07-25 10:44:11 -07:00
.nvmrc Update package and node version 2021-12-15 07:08:37 -08:00
.prettierrc.js JS formatting files 2021-10-19 10:35:46 +13:00
.stylelintrc Deprecate stylelint-config-wordpress with current package 2021-12-14 09:14:54 -08:00
CODE_OF_CONDUCT.md Fixed a typo 2017-06-19 16:22:40 -03:00
DEVELOPMENT.md Expand Repository Development Documentation (#33423) 2022-06-15 21:55:25 -07:00
README.md Update the readme link to Facebook WC group (#34150) 2022-08-01 21:20:39 -07:00
SECURITY.md Removed the reference to WP mobile apps. 2020-10-02 11:51:35 +02:00
changelog.txt Added WooCommerce 6.7.0 To Changelog (#33831) 2022-07-13 09:03:24 -07:00
package.json Add cherry pick tool (#33870) 2022-07-14 07:36:15 -07:00
phpcs.xml Add phpcs-changed (#33584) 2022-06-27 11:46:29 -07:00
pnpm-lock.yaml Add cherry pick tool (#33870) 2022-07-14 07:36:15 -07:00
pnpm-workspace.yaml Add cherry pick tool (#33870) 2022-07-14 07:36:15 -07:00
renovate.json Converted Spaces To Tabs In JSON 2022-05-10 13:31:01 -07:00
tsconfig.base.json Removed `@woocommerce/notices` Internal Prefix (#33283) 2022-06-03 16:05:26 -07:00
turbo.json Update woocommerce admin scripts to align more with turborepo (#33982) 2022-07-22 08:32:03 -03:00

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 -- turbo run build

At this point you are now ready to begin developing and testing. All of the build outputs are cached running pnpm -- turbo 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.