woocommerce/plugins/woocommerce-admin/README.md

# WooCommerce Admin

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

---

:warning: 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](https://github.com/woocommerce/woocommerce-admin/issues). **We do not recommend running this on production sites.**

---

## Prerequisites

[WordPress 5.2 or greater](https://wordpress.org/download/) and [WooCommerce 3.6.0 or greater](https://wordpress.org/plugins/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:

 - `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](./CONTRIBUTING.md#helper-scripts)

For some debugging tools/help [see here](./CONTRIBUTING.md#debugging)

## 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](./CONTRIBUTING.md)
-												Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183)


											
										
										
											2018-07-10 12:48:06 +00:00
+								# WooCommerce Admin
-												Add an admin page, build a simple component + filters
											
										
										
											2018-04-17 23:51:48 +00:00
-												Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183)


											
										
										
											2018-07-10 12:48:06 +00:00
+								This is a feature plugin for a modern, javascript-driven WooCommerce Admin experience.
-												Add an admin page, build a simple component + filters
											
										
										
											2018-04-17 23:51:48 +00:00
-												Add "in progress" banner to readme (https://github.com/woocommerce/woocommerce-admin/pull/211)

* Update README

* Update where to get v3 of the WC REST API

											
										
										
											2018-07-17 15:50:11 +00:00
+								---
-												Update text domain. (https://github.com/woocommerce/woocommerce-admin/pull/1795)

* Translation call text domain change from “wc-admin” to “woocommerce-admin”.

* Fix .pot file generation.

* Fix errantly closed array item in /revenue/stats controller.

* Rename plugin zip, main file, and repo name to "woocommerce-admin".

											
										
										
											2019-03-13 17:14:02 +00:00
+								:warning: 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](https://github.com/woocommerce/woocommerce-admin/issues). **We do not recommend running this on production sites.**
-												Add "in progress" banner to readme (https://github.com/woocommerce/woocommerce-admin/pull/211)

* Update README

* Update where to get v3 of the WC REST API

											
										
										
											2018-07-17 15:50:11 +00:00
 								---
-												Add Gutenberg & WooCommerce prereq to the README (https://github.com/woocommerce/woocommerce-admin/pull/1)

* Add Gutenberg prereq to the README

I installed `woo-dash` without Gutenberg installed and ended up getting a fatal error. We should probably fix that as well/handle that better, but if we are going to rely on Gutenberg for the feature plugin we should mention it in the README.

* Add mention of WooCommerce as a prereq

											
										
										
											2018-05-02 18:28:59 +00:00
+								## Prerequisites
-												Revert "Revert "Update to new Snackbar component and notice store"" (https://github.com/woocommerce/woocommerce-admin/pull/2643)

* Revert "Revert "Update to new Snackbar component and notice store""

* Update uploader component to use createNotice

* Bump required WP version to 5.2

* Update required PHP and WP versions in plugin header

											
										
										
											2019-07-23 03:26:46 +00:00
+								[WordPress 5.2 or greater](https://wordpress.org/download/) and [WooCommerce 3.6.0 or greater](https://wordpress.org/plugins/woocommerce/) should be installed prior to activating the WooCommerce Admin feature plugin.
-												Add Gutenberg & WooCommerce prereq to the README (https://github.com/woocommerce/woocommerce-admin/pull/1)

* Add Gutenberg prereq to the README

I installed `woo-dash` without Gutenberg installed and ended up getting a fatal error. We should probably fix that as well/handle that better, but if we are going to rely on Gutenberg for the feature plugin we should mention it in the README.

* Add mention of WooCommerce as a prereq

											
										
										
											2018-05-02 18:28:59 +00:00
-												Fix React warnings for nested components/className (https://github.com/woocommerce/woocommerce-admin/pull/83)

* Fix class/className warning

* Fix nested `a` warning

* Add note about SCRIPT_DEBUG

											
										
										
											2018-05-23 18:01:41 +00:00
+								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.
-												Add an admin page, build a simple component + filters
											
										
										
											2018-04-17 23:51:48 +00:00
+								## Development
-												Readme: add composer install step

											
										
										
											2019-08-21 19:17:05 +00:00
+								After cloning the repo, install dependencies:
-												update README.md and CONTRIBUTING.md (https://github.com/woocommerce/woocommerce-admin/pull/2963)


											
										
										
											2019-09-26 11:35:54 +00:00
-												Readme: add composer install step

											
										
										
											2019-08-21 19:17:05 +00:00
+								 - `npm install` to install JavaScript dependencies.
 								 - `composer install` to gather PHP dependencies.
 								Now you can build the files using one of these commands:
-												Add an admin page, build a simple component + filters
											
										
										
											2018-04-17 23:51:48 +00:00
 								 - `npm run build` : Build a production version
-												Ensure the feature-config.php file is built with `npm run build` (https://github.com/woocommerce/woocommerce-admin/pull/2115)

* Ensure the feature-config file is built

* Missing doc for `dev` build

* Call feature flag build once

* Inline docs with updated default

											
										
										
											2019-04-26 18:37:39 +00:00
+								 - `npm run dev` : Build a development version
-												Build Tools: Add precommit/prepush scripts, install if outdated (https://github.com/woocommerce/woocommerce-admin/pull/34)

* Add helper scripts from calypso

* Add the pre-push hook to protect master

* Add required packages

* Update README

* Remove unused package

											
										
										
											2018-05-10 19:17:28 +00:00
+								 - `npm start` : Build a development version, watch files for changes
-												Update text domain. (https://github.com/woocommerce/woocommerce-admin/pull/1795)

* Translation call text domain change from “wc-admin” to “woocommerce-admin”.

* Fix .pot file generation.

* Fix errantly closed array item in /revenue/stats controller.

* Rename plugin zip, main file, and repo name to "woocommerce-admin".

											
										
										
											2019-03-13 17:14:02 +00:00
+								 - `npm run build:release` : Build a WordPress plugin ZIP file (`woocommerce-admin.zip` will be created in the repository root)
-												Add an admin page, build a simple component + filters
											
										
										
											2018-04-17 23:51:48 +00:00
-												update README.md and CONTRIBUTING.md (https://github.com/woocommerce/woocommerce-admin/pull/2963)


											
										
										
											2019-09-26 11:35:54 +00:00
+								For more helper scripts [see here](./CONTRIBUTING.md#helper-scripts)
-												Execute single order pending jobs immediately when wp_debug is enabled (https://github.com/woocommerce/woocommerce-admin/pull/1581)

* Execute all pending jobs when debug mode is enabled

* Only process single order jobs immediately

* Replace wp_debug condition with a filter

* Bypass scheduling and process the order on save_post

* Change hook name to include order

											
										
										
											2019-02-20 02:05:11 +00:00
-												update README.md and CONTRIBUTING.md (https://github.com/woocommerce/woocommerce-admin/pull/2963)


											
										
										
											2019-09-26 11:35:54 +00:00
+								For some debugging tools/help [see here](./CONTRIBUTING.md#debugging)
-												Execute single order pending jobs immediately when wp_debug is enabled (https://github.com/woocommerce/woocommerce-admin/pull/1581)

* Execute all pending jobs when debug mode is enabled

* Only process single order jobs immediately

* Replace wp_debug condition with a filter

* Bypass scheduling and process the order on save_post

* Change hook name to include order

											
										
										
											2019-02-20 02:05:11 +00:00
-												Add privacy notice regarding wp.com

											
										
										
											2018-10-17 20:49:06 +00:00
+								## 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.
-												Add markdown docs with details on contributing

											
										
										
											2018-10-31 23:12:11 +00:00
 								## Contributing
-												Add instructions for translating to contributing docs.

											
										
										
											2019-07-09 16:12:34 +00:00
+								There are many ways to contribute – reporting bugs, adding translations, feature suggestions and fixing bugs. For full details, please see [CONTRIBUTING.md](./CONTRIBUTING.md)