Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/README.md

54 lines
3.0 KiB
Markdown
Raw Normal View History

Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) * Add api-fetch dependency * Remove compiled files from the repo * Update build process, remove grunt * Import CSS into block, as we now extract CSS via webpack to build * Update enqueue scripts to reflect new build locations * Detect if build files don’t exist, and instruct users to build project * Update readme with build instructions * Clarify where to run npm commands in info notice * Only enqueue our JS files if we know they exist * Clarify version compatibility between WC and WP 5.0
2018-11-13 19:12:32 +00:00
# WooCommerce Product Blocks
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
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.
Initialize with readme
2018-02-13 17:32:11 +00:00
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
## Table of Contents
- [Installing the stable version](#installing-the-stable-version)
- [Installing the development version](#installing-the-development-version)
- [Getting started with block development](#getting-started-with-block-development)
- [Contributing](CONTRIBUTING.md)
- [About the npm scripts](CONTRIBUTING.md#npm-scripts)
- [Publishing a release](CONTRIBUTING.md#publishing-woocommerceblock-library)
- Code Documentation
- [Blocks](assets/js/blocks)
- [Components](assets/js/components)
## Installing the stable version
Readme
2018-04-20 17:17:55 +00:00
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
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.](https://wordpress.org/plugins/woo-gutenberg-products-block/)
3. Activate the plugin.
Initialize with readme
2018-02-13 17:32:11 +00:00
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
## Installing the development version
REST API: Add new parameter for relationship between multiple taxonomies (https://github.com/woocommerce/woocommerce-blocks/pull/377) * Add new API parameter `tax_relation`, to handle relationship between multiple taxonomies * Minor change to trigger a travis build
2019-01-30 21:08:21 +00:00
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
1. Make sure you have WordPress 5.0+ and WooCommerce 3.6+
Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) * Add api-fetch dependency * Remove compiled files from the repo * Update build process, remove grunt * Import CSS into block, as we now extract CSS via webpack to build * Update enqueue scripts to reflect new build locations * Detect if build files don’t exist, and instruct users to build project * Update readme with build instructions * Clarify where to run npm commands in info notice * Only enqueue our JS files if we know they exist * Clarify version compatibility between WC and WP 5.0
2018-11-13 19:12:32 +00:00
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.
Initialize with readme
2018-02-13 17:32:11 +00:00
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
The source code is in the `assets/` folder and the compiled code is built into `build/`.
Initialize with readme
2018-02-13 17:32:11 +00:00
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
## Getting started with block development
Run through the ["Writing Your First Block Type" tutorial](https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/block-tutorial/) for a quick course in block-building.
For deeper dive, try looking at the [core blocks code,](https://github.com/WordPress/gutenberg/tree/master/packages/block-library/src) or see what [components are available.](https://github.com/WordPress/gutenberg/tree/master/packages/components/src)
Other useful docs to explore:
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
- [`InnerBlocks `](https://github.com/WordPress/gutenberg/blob/master/packages/block-editor/src/components/inner-blocks/README.md)
- [`apiFetch`](https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-api-fetch/)
- [`@wordpress/editor`](https://github.com/WordPress/gutenberg/blob/master/packages/editor/README.md)
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) * Add api-fetch dependency * Remove compiled files from the repo * Update build process, remove grunt * Import CSS into block, as we now extract CSS via webpack to build * Update enqueue scripts to reflect new build locations * Detect if build files don’t exist, and instruct users to build project * Update readme with build instructions * Clarify where to run npm commands in info notice * Only enqueue our JS files if we know they exist * Clarify version compatibility between WC and WP 5.0
2018-11-13 19:12:32 +00:00
## Vision for the Feature
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
Update README.md
2018-03-02 16:33:27 +00:00
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.