A feature plugin for a modern, javascript-driven WooCommerce Admin experience.
Branch: master
Clone or download
rrennick Merge pull request #1589 from woocommerce/fix/or-greater
update missed version `or greater` in update message
Latest commit f03d898 Feb 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Accessibility section to the PR template (#1133) Dec 19, 2018
bin Update 5.0.0 version check and add basic readme.txt (#1521) Feb 12, 2019
client Merge pull request #1567 from woocommerce/fix/1450 Feb 15, 2019
config Add Feature Flags (#1500) Feb 12, 2019
docs Release v0.7.0 (#1551) Feb 14, 2019
images Clean up SVG code Sep 27, 2018
includes Changed the date_created columns to datetime, in the new location of … Feb 15, 2019
languages Update woo-dash naming to new wc-admin name (#183) Jul 10, 2018
lib Add Feature Flags (#1500) Feb 12, 2019
packages Merge pull request #1567 from woocommerce/fix/1450 Feb 15, 2019
tests Merge pull request #1570 from woocommerce/phpcs/tests Feb 15, 2019
.browserslistrc Add CSS autoprefixer (#244) Jul 30, 2018
.distignore Add Feature Flags (#1500) Feb 12, 2019
.editorconfig Initial commit of plugin scaffold Apr 17, 2018
.eslintignore Docs Project: Add documentation parser + inline documentation (#336) Aug 31, 2018
.eslintrc Set eslint react version to 'detect' (#1300) Jan 17, 2019
.gitignore Add Feature Flags (#1500) Feb 12, 2019
.nvmrc Add nvmrc for newest lts release (#1108) Dec 18, 2018
.stylelintrc.json Makes stylelint config match prettier settings (#733) Nov 1, 2018
.travis.yml Corrected path to phpunit for Travis. Nov 2, 2018
CONTRIBUTING.md Update CONTRIBUTING.md with PR instructions (#1066) Dec 12, 2018
Gruntfile.js Removed addtextdomain for grunt Sep 28, 2018
LICENSE.md Add GPL License (#1440) Feb 1, 2019
README.md Adding npm test to "helper scripts" section. (#1087) Dec 14, 2018
babel.config.js Build: Update babel config (#677) Oct 24, 2018
composer.json Update/php sniffs (#1016) Dec 6, 2018
composer.lock Update/php sniffs (#1016) Dec 6, 2018
lerna.json Try: Add Lerna to split out utility packages (#678) Oct 30, 2018
package-lock.json Release v0.7.0 (#1551) Feb 14, 2019
package.json Release v0.7.0 (#1551) Feb 14, 2019
phpcs.xml.dist Update/php sniffs (#1016) Dec 6, 2018
phpunit.xml.dist Initial setup for unit tests. Sep 20, 2018
postcss.config.js Format todo comments to match WC Core format (#1474) Feb 6, 2019
readme.txt Update 5.0.0 version check and add basic readme.txt (#1521) Feb 12, 2019
renovate.json Change renovate to a once-weekly schedule (#1076) Dec 13, 2018
wc-admin.php update missed version `or greater` in update message Feb 15, 2019
webpack.config.js Add Feature Flags (#1500) Feb 12, 2019

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
  • npm run build:release : Build a WordPress plugin ZIP file (wc-admin.zip will be created in the repository root)

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).
  • npm test : Run the JS test suite

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