History

Jeff Stieler d3e940208e Refactor package style builds (https://github.com/woocommerce/woocommerce-admin/pull/7531 ) * Build experimental package CSS with webpack. * Move style-only webpack config to reusable private package. * Update other packages to use webpack for style builds. * Add tsbuildinfo to clean scripts. * Fix main start script. * Remove defunct package build scripts. * Move client/ dependencies for style builds. * DRY. * Remove defunct IE stylesheet definitions. * Add missing RTL setup for onboarding styles. * No need to export a function. * Add changelog. * Fix README. * Revert concurrently script path change.		2021-08-19 10:15:59 -04:00
..
components	Publish storybook docs, remove react docgen based docs (https://github.com/woocommerce/woocommerce-admin/pull/7055 )	2021-06-02 15:54:00 +12:00
examples	Add a delete option to completed tasks (https://github.com/woocommerce/woocommerce-admin/pull/7300 )	2021-07-06 15:35:40 -03:00
features	Remove the preloaded onboarding options (https://github.com/woocommerce/woocommerce-admin/pull/7338 )	2021-08-10 14:58:01 -04:00
woocommerce.com	Sentence case all the things analytics (https://github.com/woocommerce/woocommerce-admin/pull/6501 )	2021-08-13 14:54:24 -04: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	Update Minimum version in docs and test configs (https://github.com/woocommerce/woocommerce-admin/pull/6342 )	2021-02-19 11:22:56 +13:00
_sidebar.md	Publish storybook docs, remove react docgen based docs (https://github.com/woocommerce/woocommerce-admin/pull/7055 )	2021-06-02 15:54:00 +12:00
data.md	Master -> main. (https://github.com/woocommerce/woocommerce-admin/pull/4618 )	2020-06-17 13:39:41 -04:00
index.html	Fix Google Analytics tracking for static docs site. (https://github.com/woocommerce/woocommerce-admin/pull/7439 )	2021-07-30 15:25:59 +12: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
page-controller.md	Fix Markdown formatting in page-controller.md (https://github.com/woocommerce/woocommerce-admin/pull/6347 )	2021-02-17 14:07:54 +13:00
stylesheets.md	Refactor package style builds (https://github.com/woocommerce/woocommerce-admin/pull/7531 )	2021-08-19 10:15:59 -04:00

README.md

WooCommerce Admin

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

Prerequisites

WordPress 5.4 or greater and WooCommerce 4.8.0 or greater 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:

npm install to install JavaScript dependencies.
composer install to gather PHP dependencies.

Now you can build the files using one of these commands:

npm run build : Build a production version
npm run dev : Build a development version
npm start : Build a development version, watch files for changes
npm run build:release : Build a WordPress plugin ZIP file (woocommerce-admin.zip will be created in the repository root)

For more helper scripts see here

For some debugging tools/help see here

Privacy

If you have enabled WooCommerce usage tracking ( option woocommerce_allow_tracking ) then, in addition to the tracking described in https://woocommerce.com/usage-tracking/, this plugin also sends information about the actions that site administrators perform to Automattic - see https://automattic.com/privacy/#information-we-collect-automatically for more information.

Contributing

There are many ways to contribute – reporting bugs, adding translations, feature suggestions and fixing bugs. For full details, please see CONTRIBUTING.md