woocommerce/plugins/woocommerce-admin
renovate[bot] 3dd11ae8d5 Update dependency webpack to v4.25.1 (https://github.com/woocommerce/woocommerce-admin/pull/780) 2018-11-05 15:29:55 -05:00
..
.github Remove format comment 2018-10-16 11:56:31 -04:00
bin Add command to build release zip (https://github.com/woocommerce/woocommerce-admin/pull/768) 2018-11-05 10:11:34 -05:00
client Persist time queries when clicking on breadcrumbs links (https://github.com/woocommerce/woocommerce-admin/pull/759) 2018-11-02 22:38:16 +01:00
docs Updates docs files (https://github.com/woocommerce/woocommerce-admin/pull/769) 2018-11-04 16:25:00 -05:00
images Clean up SVG code 2018-09-27 15:41:12 -07:00
includes Update order summary in Orders report (https://github.com/woocommerce/woocommerce-admin/pull/613) 2018-10-31 14:09:38 -05:00
languages Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183) 2018-07-10 08:48:06 -04:00
lib Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678) 2018-10-30 14:57:48 -04:00
packages Update wordpress monorepo (https://github.com/woocommerce/woocommerce-admin/pull/745) 2018-11-03 13:23:57 -04:00
tests Update order summary in Orders report (https://github.com/woocommerce/woocommerce-admin/pull/613) 2018-10-31 14:09:38 -05:00
.browserslistrc Add CSS autoprefixer (https://github.com/woocommerce/woocommerce-admin/pull/244) 2018-07-30 10:05:22 -04:00
.distignore Initial commit of plugin scaffold 2018-04-17 17:04:17 -04:00
.editorconfig Initial commit of plugin scaffold 2018-04-17 17:04:17 -04:00
.eslintignore Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336) 2018-08-31 13:27:21 -04:00
.eslintrc Search: Add inline tags 2018-10-12 11:34:08 +13:00
.gitignore Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678) 2018-10-30 14:57:48 -04:00
.stylelintrc.json Makes stylelint config match prettier settings (https://github.com/woocommerce/woocommerce-admin/pull/733) 2018-11-01 17:03:00 -04:00
.travis.yml Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678) 2018-10-30 14:57:48 -04:00
CONTRIBUTING.md Remove credits for now, at least until we need to do something like that 2018-11-01 13:07:27 -07:00
Gruntfile.js Removed addtextdomain for grunt 2018-09-28 12:23:19 -03:00
README.md Add markdown docs with details on contributing 2018-10-31 16:12:11 -07:00
babel.config.js Build: Update babel config (https://github.com/woocommerce/woocommerce-admin/pull/677) 2018-10-24 17:17:23 -04:00
composer.json Update dependency dealerdirect/phpcodesniffer-composer-installer to v0.5.0 (https://github.com/woocommerce/woocommerce-admin/pull/712) 2018-10-29 11:33:32 -04:00
composer.lock Update dependency dealerdirect/phpcodesniffer-composer-installer to v0.5.0 (https://github.com/woocommerce/woocommerce-admin/pull/712) 2018-10-29 11:33:32 -04:00
lerna.json Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678) 2018-10-30 14:57:48 -04:00
package-lock.json Update dependency webpack to v4.25.1 (https://github.com/woocommerce/woocommerce-admin/pull/780) 2018-11-05 15:29:55 -05:00
package.json Update dependency webpack to v4.25.1 (https://github.com/woocommerce/woocommerce-admin/pull/780) 2018-11-05 15:29:55 -05:00
phpcs.xml.dist Adds php compatibility range for phpcs (https://github.com/woocommerce/woocommerce-admin/pull/618) 2018-10-24 09:09:33 -04:00
phpunit.xml.dist Initial setup for unit tests. 2018-09-20 16:20:04 +02:00
postcss.config.js IE11: fix CSS grid in Summary (https://github.com/woocommerce/woocommerce-admin/pull/353) 2018-09-06 17:11:34 +02:00
renovate.json Add renovate.json (https://github.com/woocommerce/woocommerce-admin/pull/552) 2018-10-18 12:26:57 -04:00
wc-admin.php Do not attempt to run table setup without dependency check first 2018-11-04 17:50:53 -05:00
webpack.config.js Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678) 2018-10-30 14:57:48 -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:

  • npm run lint : Run eslint over the javascript files
  • npm run i18n : A multi-step process, used to create a pot file from both the JS and PHP gettext calls. First it runs i18n:js, which creates a temporary .pot file from the JS files. Next it runs i18n:php, which converts that .pot file to a PHP file. Lastly, it runs i18n:pot, which creates the final .pot file from all the PHP files in the plugin (including the generated one with the JS strings).

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, feature suggestions and fixing bugs. For full details, please see CONTRIBUTING.md