woocommerce/plugins/woocommerce-blocks
renovate[bot] 53163608a2 Update dependency @woocommerce/components to v3.1.0 (https://github.com/woocommerce/woocommerce-blocks/pull/692) 2019-07-05 12:48:12 +02:00
..
.github Update pull_request_template.md 2019-07-01 12:01:45 +01:00
assets Add placeholder when no categories exist to list (https://github.com/woocommerce/woocommerce-blocks/pull/678) 2019-07-04 16:05:59 +01:00
bin WordPress org release script (https://github.com/woocommerce/woocommerce-blocks/pull/685) 2019-07-04 16:01:06 +01:00
languages Build: Add translation conversion script (https://github.com/woocommerce/woocommerce-blocks/pull/486) 2019-03-13 09:59:12 -04:00
src Re-introduce set_ordering_query_args (https://github.com/woocommerce/woocommerce-blocks/pull/668) 2019-07-02 10:37:50 +01:00
tests Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00
.editorconfig Add .editorconfig file for editor integration (https://github.com/woocommerce/woocommerce-blocks/pull/128) 2018-11-16 10:42:56 -05:00
.eslintignore Update eslint config to ignore legacy block (https://github.com/woocommerce/woocommerce-blocks/pull/176) 2018-11-30 13:18:52 -05:00
.eslintrc.js Add/block product categories (https://github.com/woocommerce/woocommerce-blocks/pull/613) 2019-06-17 10:23:59 -04:00
.gitattributes WordPress org release script (https://github.com/woocommerce/woocommerce-blocks/pull/685) 2019-07-04 16:01:06 +01:00
.gitignore Build: Add translation conversion script (https://github.com/woocommerce/woocommerce-blocks/pull/486) 2019-03-13 09:59:12 -04:00
.nvmrc Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05: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 Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00
CONTRIBUTING.md WordPress org release script (https://github.com/woocommerce/woocommerce-blocks/pull/685) 2019-07-04 16:01:06 +01:00
README.md Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551) 2019-05-09 10:45:09 -04:00
babel.config.js chore(deps): update wordpress monorepo (major) (https://github.com/woocommerce/woocommerce-blocks/pull/475) 2019-03-06 13:50:44 -05:00
composer.json Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00
composer.lock Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00
package-lock.json Update dependency @woocommerce/components to v3.1.0 (https://github.com/woocommerce/woocommerce-blocks/pull/692) 2019-07-05 12:48:12 +02:00
package.json Update dependency @woocommerce/components to v3.1.0 (https://github.com/woocommerce/woocommerce-blocks/pull/692) 2019-07-05 12:48:12 +02:00
phpcs.xml Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01: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 Update dependency autoprefixer to v9.6.0 (https://github.com/woocommerce/woocommerce-blocks/pull/614) 2019-06-10 10:24:22 -04:00
readme.txt Update changelog 2019-07-04 11:41:21 +01:00
renovate.json Roll back husky update to 2.4.1 (https://github.com/woocommerce/woocommerce-blocks/pull/646) 2019-06-25 10:20:28 +01:00
webpack.config.js Abstract block refactor (https://github.com/woocommerce/woocommerce-blocks/pull/656) 2019-07-01 15:26:06 +01:00
woocommerce-gutenberg-products-block.php Move main controllers from assets/php to src (https://github.com/woocommerce/woocommerce-blocks/pull/655) 2019-07-01 13:52:44 +01:00

README.md

WooCommerce Product Blocks

Feature plugin for WooCoomerce + Gutenberg. Now that the product blocks have been merged into WooCommerce 3.6, this plugin serves as a space to iterate and explore how else WooCommerce might work with the block editor.

If you're just looking to use these blocks, update to WooCommerce 3.6! The blocks are bundled into WooCommerce, 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.6+
  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.6+
  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. npm run build (build once) or npm start (keep watching for changes) to compile the code.
  5. 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.