woocommerce/plugins/woocommerce-blocks
Albert Juhé Lluveras 3a4c3229fb Add schedule to renovate bot config (https://github.com/woocommerce/woocommerce-blocks/pull/598) 2019-08-21 14:39:54 +02:00
..
.github Create issue_label_bot.yaml 2019-07-09 10:36:17 +01:00
assets Review blocks: fix attribute notices not appearing (https://github.com/woocommerce/woocommerce-blocks/pull/888) 2019-08-21 12:48:22 +02:00
bin Add changelog script (https://github.com/woocommerce/woocommerce-blocks/pull/878) 2019-08-19 12:46:32 +02:00
languages Build: Add translation conversion script (https://github.com/woocommerce/woocommerce-blocks/pull/486) 2019-03-13 09:59:12 -04:00
src Reviews by category block (https://github.com/woocommerce/woocommerce-blocks/pull/804) 2019-08-19 15:13:07 +01:00
tests Move wc_product_block_data variables to constants file (https://github.com/woocommerce/woocommerce-blocks/pull/870) 2019-08-17 11:14:11 +02: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 Create Reviews by Product block (https://github.com/woocommerce/woocommerce-blocks/pull/658) 2019-08-15 16:55:57 +02:00
.gitattributes WordPress org release script (https://github.com/woocommerce/woocommerce-blocks/pull/685) 2019-07-04 16:01:06 +01: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
.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 Add bundlesize package and tweak travis config (https://github.com/woocommerce/woocommerce-blocks/pull/822) 2019-08-09 14:08:31 -04:00
CONTRIBUTING.md Updated deploy instructions 2019-08-12 11:48:58 +00:00
README.md add composer install to readme (https://github.com/woocommerce/woocommerce-blocks/pull/738) 2019-07-17 11:06:06 +12:00
bundlesize.config.json Create Reviews by Product block (https://github.com/woocommerce/woocommerce-blocks/pull/658) 2019-08-15 16:55:57 +02:00
composer.json Update dependency composer/installers to v1.7.0 (https://github.com/woocommerce/woocommerce-blocks/pull/842) 2019-08-13 11:40:01 +01:00
composer.lock Update dependency composer/installers to v1.7.0 (https://github.com/woocommerce/woocommerce-blocks/pull/842) 2019-08-13 11:40:01 +01:00
package-lock.json Update dependency eslint to v6.2.1 (https://github.com/woocommerce/woocommerce-blocks/pull/890) 2019-08-20 14:35:08 +01:00
package.json Set eslint version back to 6.1.0 (https://github.com/woocommerce/woocommerce-blocks/pull/896) 2019-08-21 12:52:10 +01: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 Create Reviews by Product block (https://github.com/woocommerce/woocommerce-blocks/pull/658) 2019-08-15 16:55:57 +02:00
readme.txt Add README note for PHP deprecation notices 2019-08-15 13:03:41 +02:00
renovate.json Add schedule to renovate bot config (https://github.com/woocommerce/woocommerce-blocks/pull/598) 2019-08-21 14:39:54 +02:00
webpack.config.js Reviews by category block (https://github.com/woocommerce/woocommerce-blocks/pull/804) 2019-08-19 15:13:07 +01:00
woocommerce-gutenberg-products-block.php Master is now `2.4.0-dev` 2019-07-11 11:03:16 +01:00

README.md

WooCommerce Product Blocks

Feature plugin for WooCommerce + 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. 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.