5c8cfbc03f
* Extend docs to report components * Improve inline documentation in some files * Update doc files * Undo unnecessary doc changes * Remove unnecessary line breaks in sidebar * Rename 'Client components' to 'Analytics components' * Minor docs fixes * Rename toc contents to toc sections * Update endpoint props doc to add an example and more information * Fix outdated comment * Fix merge error |
||
|---|---|---|
| .. | ||
| components | ||
| examples | ||
| .nojekyll | ||
| README.md | ||
| _sidebar.md | ||
| data.md | ||
| documentation.md | ||
| index.html | ||
| layout.md | ||
| stylesheets.md | ||
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 versionnpm start: Build a development version, watch files for changes
There are also some helper scripts:
npm run lint: Run eslint over the javascript filesnpm run i18n: Create a PHP file with the strings from the javascript files, used to get around lack of JS support in WordPress.org.
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.