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-admin/docs
History
Timmy Crawford eeff9572f5 Documentation: Add base directory and files (https://github.com/woocommerce/woocommerce-admin/pull/3404) 
* Let us get this docparty started.

* Report page stubs.
 		2019-12-16 10:29:01 -08:00
..
components Remove Newspack Dependency (https://github.com/woocommerce/woocommerce-admin/pull/3302) 2019-12-02 12:39:22 -05:00
examples AssetDataRegistry: update SQL example (https://github.com/woocommerce/woocommerce-admin/pull/3418) 2019-12-17 07:16:46 +13:00
features Update onboarding filters with a consistent prefix (https://github.com/woocommerce/woocommerce-admin/pull/3295) 2019-11-25 11:15:22 -05:00
woocommerce.com Documentation: Add base directory and files (https://github.com/woocommerce/woocommerce-admin/pull/3404) 2019-12-16 10:29:01 -08: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 Bump minimum WP version to 5.3 (https://github.com/woocommerce/woocommerce-admin/pull/3393) 2019-12-13 10:05:41 -05:00
_sidebar.md Add base documentation for the onboarding feature (https://github.com/woocommerce/woocommerce-admin/pull/3274) 2019-11-19 13:06:38 -05:00
data.md Data store refactor (https://github.com/woocommerce/woocommerce-admin/pull/2961) 2019-11-07 10:28:37 -07:00
documentation.md Change all remaining URLs from #/style to ?path=style 2019-07-01 09:15:46 +01:00
index.html Update to Color Studio v2.1.0 (https://github.com/woocommerce/woocommerce-admin/pull/2837) 2019-08-29 12:07:56 -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
page-controller.md Remove defunct filename prefix from remaining files. 2019-08-12 15:06:36 -07: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

WordPress 5.3 or greater and WooCommerce 3.6.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