woocommerce/plugins/woocommerce-blocks
renovate[bot] cc0ee50685 Update dependency core-js to v3.6.1 (https://github.com/woocommerce/woocommerce-blocks/pull/1438) 2019-12-25 12:45:08 +01:00
..
.github Create issue_label_bot.yaml 2019-07-09 10:36:17 +01:00
.sources New block: Filter Products by Price (https://github.com/woocommerce/woocommerce-blocks/pull/853) 2019-11-01 13:56:14 +00:00
assets Fix double 'yet yet' (https://github.com/woocommerce/woocommerce-blocks/pull/1421) 2019-12-20 10:35:08 +01:00
bin Update dependency eslint to v6.8.0 (https://github.com/woocommerce/woocommerce-blocks/pull/1439) 2019-12-25 12:44:47 +01:00
src Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) 2019-12-20 16:07:53 +00:00
tests Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) 2019-12-20 16:07:53 +00:00
.editorconfig Introduce legacy build system and new aliases (https://github.com/woocommerce/woocommerce-blocks/pull/1018) 2019-10-06 08:36:15 -04:00
.eslintignore Install prettier and reformat files (https://github.com/woocommerce/woocommerce-blocks/pull/945) 2019-09-05 17:09:31 +02:00
.eslintrc.js Update dependencies order (https://github.com/woocommerce/woocommerce-blocks/pull/1146) 2019-11-08 17:30:11 +01:00
.gitattributes Create CODEOWNERS file (https://github.com/woocommerce/woocommerce-blocks/pull/1013) 2019-10-02 19:08:05 +02:00
.gitignore Add `package-plugin` script (https://github.com/woocommerce/woocommerce-blocks/pull/689) 2019-07-09 12:37:25 +01:00
.nvmrc Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05:00
.prettierrc Fix increment bug in withComponentId (https://github.com/woocommerce/woocommerce-blocks/pull/951) 2019-09-07 08:04:34 -04:00
.stylelintrc.json Add stylelint to find and fix css code style issues (https://github.com/woocommerce/woocommerce-blocks/pull/126) 2018-11-15 10:45:49 -05:00
.travis.yml Configure travis to only run on master or release branches (does not affect pull builds) 2019-12-11 10:04:25 -05:00
CODEOWNERS Create CODEOWNERS file (https://github.com/woocommerce/woocommerce-blocks/pull/1013) 2019-10-02 19:08:05 +02:00
CONTRIBUTING.md Update Contributors.md for releasing a new minor version (https://github.com/woocommerce/woocommerce-blocks/pull/1403) 2019-12-18 11:30:03 +00:00
README.md Update minimum WooCommerce version to 3.7 (https://github.com/woocommerce/woocommerce-blocks/pull/1181) 2019-11-15 16:32:40 +01:00
composer.json Update dependency automattic/jetpack-autoloader to v1.3.2 (https://github.com/woocommerce/woocommerce-blocks/pull/990) 2019-09-25 12:25:37 +02:00
composer.lock Update NPM dependencies and script dependency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1337) 2019-12-10 12:17:46 -05:00
package-lock.json Update dependency core-js to v3.6.1 (https://github.com/woocommerce/woocommerce-blocks/pull/1438) 2019-12-25 12:45:08 +01:00
package.json Update dependency core-js to v3.6.1 (https://github.com/woocommerce/woocommerce-blocks/pull/1438) 2019-12-25 12:45:08 +01:00
phpcs.xml Update NPM dependencies and script dependency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1337) 2019-12-10 12:17:46 -05:00
phpunit.xml.dist Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00
postcss.config.js Create Reviews by Product block (https://github.com/woocommerce/woocommerce-blocks/pull/658) 2019-08-15 16:55:57 +02:00
readme.txt Update filter blocks descriptions to explain they only work with the All Products block (https://github.com/woocommerce/woocommerce-blocks/pull/1420) 2019-12-19 13:46:30 +01:00
renovate.json Lock file maintenance (https://github.com/woocommerce/woocommerce-blocks/pull/1023) 2019-10-07 11:05:35 +01:00
webpack.config.js Fix broken cart & checkout blocks due to inconsistent block names between server side and client side registration (https://github.com/woocommerce/woocommerce-blocks/pull/1353) 2019-12-09 15:50:49 -05:00
woocommerce-gutenberg-products-block.php Fix package init for WooCommerce 3.9 (https://github.com/woocommerce/woocommerce-blocks/pull/1335) 2019-12-09 16:44:28 +00:00

README.md

WooCommerce Product Blocks

Feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks for WooCommerce, and how WooCommerce might work with the block editor.

If you're just looking to use these blocks, update to the latest version of WooCommerce! The blocks are bundled into WooCommerce since version 3.6, and can be added from the "WooCommerce" section in the block inserter.

If you want to see what we're working on for future versions, or want to help out, read on.

Table of Contents

Installing the stable version

We release a new version of WooCommerce Blocks onto WordPress.org every few weeks, which can be used as an easier way to preview the features.

  1. Make sure you have WordPress 5.0+ and WooCommerce 3.7+
  2. The stable version is available on WordPress.org. Download the stable version here.
  3. Activate the plugin.

Installing the development version

  1. Make sure you have WordPress 5.0+ and WooCommerce 3.7+
  2. Get a copy of this plugin using the green "Clone or download" button on the right.
  3. npm install to install the dependencies.
  4. composer install to install core dependencies.
  5. npm run build (build once) or npm start (keep watching for changes) to compile the code.
  6. Activate the plugin.

The source code is in the assets/ folder and the compiled code is built into build/.

Getting started with block development

Run through the "Writing Your First Block Type" tutorial for a quick course in block-building.

For deeper dive, try looking at the core blocks code, or see what components are available.

Other useful docs to explore:

Vision for the Feature

Users should be able to insert a variety of products from their store (specific products, products in a category, with assorted layouts and visual styles, etc.) into their post content using a simple and powerful visual editor.