woocommerce/plugins/woocommerce-blocks
Kelly Dwan 7db16590ce Add instructions for testing `@woocommerce/block-library` locally (https://github.com/woocommerce/woocommerce-blocks/pull/578) 2019-05-21 11:16:43 +01:00
..
.github Update bug report template to include WordPress details 2019-01-18 14:44:11 -05:00
assets Update/dynamic grid blocks html (https://github.com/woocommerce/woocommerce-blocks/pull/567) 2019-05-16 17:30:40 +01:00
bin Build: Add translation conversion script (https://github.com/woocommerce/woocommerce-blocks/pull/486) 2019-03-13 09:59:12 -04:00
languages Build: Add translation conversion script (https://github.com/woocommerce/woocommerce-blocks/pull/486) 2019-03-13 09:59:12 -04:00
tests Update grid blocks preview to match width of products on the frontend (https://github.com/woocommerce/woocommerce-blocks/pull/489) 2019-03-15 12:48:46 -04: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 Update eslint config to ignore legacy block (https://github.com/woocommerce/woocommerce-blocks/pull/176) 2018-11-30 13:18:52 -05:00
.gitattributes Add gitatributes file 2018-04-23 10:34:21 -07: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 Add pre-publishing script and bump version to 2.0.0-rc1 (https://github.com/woocommerce/woocommerce-blocks/pull/494) 2019-03-15 12:55:34 -04:00
CONTRIBUTING.md Add instructions for testing `@woocommerce/block-library` locally (https://github.com/woocommerce/woocommerce-blocks/pull/578) 2019-05-21 11:16:43 +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 chore(deps): update dependency woocommerce/woocommerce-sniffs to v0.0.6 (https://github.com/woocommerce/woocommerce-blocks/pull/482) 2019-03-12 09:57:19 -04:00
composer.lock chore(deps): update dependency woocommerce/woocommerce-sniffs to v0.0.6 (https://github.com/woocommerce/woocommerce-blocks/pull/482) 2019-03-12 09:57:19 -04:00
license.txt Readme 2018-04-20 10:17:55 -07:00
package-lock.json Update dependency core-js to v2.6.7 (https://github.com/woocommerce/woocommerce-blocks/pull/579) 2019-05-21 11:19:08 +02:00
package.json Update dependency core-js to v2.6.7 (https://github.com/woocommerce/woocommerce-blocks/pull/579) 2019-05-21 11:19:08 +02:00
phpcs.xml Fix PHP CodeSniffer issues (https://github.com/woocommerce/woocommerce-blocks/pull/215) 2018-12-11 11:14:02 -06:00
phpunit.xml.dist Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05:00
postcss.config.js Split blocks into separate JS files (https://github.com/woocommerce/woocommerce-blocks/pull/305) 2019-01-10 13:16:37 -05:00
readme.txt Bump to dev version (https://github.com/woocommerce/woocommerce-blocks/pull/564) 2019-05-15 08:37:48 +01:00
renovate.json Add renovate.json (https://github.com/woocommerce/woocommerce-blocks/pull/127) 2018-11-15 16:55:12 -05:00
webpack.config.js Show build progress (https://github.com/woocommerce/woocommerce-blocks/pull/557) 2019-05-13 13:08:32 +01:00
woocommerce-gutenberg-products-block.php Bump to dev version (https://github.com/woocommerce/woocommerce-blocks/pull/564) 2019-05-15 08:37:48 +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.