woocommerce/plugins/woocommerce-admin/docs
Albert Juhé Lluveras 776e8d31fe Merge pull request woocommerce/woocommerce-admin#1085 from woocommerce/add/name-filter-autocompleter
Customers report: Name Advanced Filter
2018-12-19 10:39:22 +01:00
..
components Merge branch 'master' into add/name-filter-autocompleter 2018-12-18 13:52:48 +01:00
examples Fix typos and bad grammar, add more links 2018-11-04 21:49:35 -05:00
.nojekyll Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) 2018-08-31 16:13:20 -04:00
README.md Add section on "Dev Docs" (https://github.com/woocommerce/woocommerce-admin/pull/1123) 2018-12-18 16:49:30 -06:00
_sidebar.md Add documentation for how to write documentation (https://github.com/woocommerce/woocommerce-admin/pull/1083) 2018-12-13 16:15:52 -05:00
data.md Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00
documentation.md Add documentation for how to write documentation (https://github.com/woocommerce/woocommerce-admin/pull/1083) 2018-12-13 16:15:52 -05:00
index.html Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00
layout.md Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00
stylesheets.md Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00

README.md

WooCommerce Admin

This is a feature plugin for a modern, javascript-driven WooCommerce Admin experience.


⚠️ This project is in active development, and is not ready for general use. You can follow the features in development by looking at the project's issues. We do not recommend running this on production sites.


Prerequisites

Gutenberg and WooCommerce should be installed prior to activating the WooCommerce Admin feature plugin.

For better debugging, it's also recommended you add define( 'SCRIPT_DEBUG', true ); to your wp-config. This will load the unminified version of all libraries, and specifically the development build of React.

Development

After cloning the repo, install dependencies with npm install. Now you can build the files using one of these commands:

  • npm run build : Build a production version
  • npm start : Build a development version, watch files for changes

There are also some helper scripts:

Dev Docs

There is a "devdocs" page which is useful for displaying components individually outside of the application. It can be viewed via a normal npm start build at http://<your-wp-site>/wp-admin/admin.php?page=wc-admin#/devdocs.

This is useful for viewing of WooCommerce components components and ad-hoc testing.