7ca9e691d4
* Migrate leaderboard tests to RTL. * Remove test of default prop value. * Migrate ReportSummary tests to RTL. * Migrate ActivityCard tests to RTL. * Migrate ActivityCardPlaceholder tests to RTL. * Migrate remaining ProductType tests to RTL. * Migrate Card tests to RTL. * Update RTL and user event packages. * Migrate Date tests to RTL. * Migrate D3Legend tests to RTL. * Migrate D3Base tests to RTL. * Migrate Gravatar tests to RTL. * Migrate ImageUpload tests to RTL. * Migrate ProductImage tests to RTL. * Migrate Rating tests to RTL. * Migrate Search tests to RTL. * Migrate Plugins tests to RTL. * Migrate SelectControl tests to RTL. * Migrate Timeline tests to RTL. Remove tests that inspect DOM since there are snapshots. * Migrate DismissModal tests to RTL. * Migrate SetupNotice tests to RTL. * Migrate WelcomeCard tests to RTL. * Fix setup error reason retrieval in ShippingBanner. * Migrate ShippingBanner tests to RTL. * Migrate RecommendedExtensions tests to RTL. * Migrate KnowledgeBase tests to RTL. * Rename enzyme setup file, modify to setup RTL. * No need to import jest-dom in test files. * Remove enzyme dependency. * Use snapshot for testing Leaderboard markup. * Switch from "not to be empty" to "be in the document". * No need to waitFor() recordEvent mock. * Be specific about clicking the "hide" button. * Use toBeVisible() instead of checking style property. |
||
---|---|---|
.. | ||
.github | ||
bin | ||
client | ||
config | ||
docs | ||
images | ||
includes | ||
languages | ||
packages | ||
src | ||
storybook | ||
tests | ||
.browserslistrc | ||
.distignore | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.prettierrc.json | ||
.stylelintrc.json | ||
.travis.yml | ||
CONTRIBUTING.md | ||
Gruntfile.js | ||
LICENSE.md | ||
README.md | ||
babel.config.js | ||
chunk-src-version-param.js | ||
composer.json | ||
composer.lock | ||
docker-compose.yaml | ||
lerna.json | ||
license.txt | ||
lint-staged.config.js | ||
package-lock.json | ||
package.json | ||
phpcs.xml.dist | ||
phpunit.xml.dist | ||
readme.txt | ||
renovate.json | ||
tsconfig.json | ||
uninstall.php | ||
unminify.js | ||
webpack.config.js | ||
woocommerce-admin.php |
README.md
WooCommerce Admin
This is a feature plugin for a modern, javascript-driven WooCommerce Admin experience.
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 versionnpm run dev
: Build a development versionnpm start
: Build a development version, watch files for changesnpm 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
Testing
End-to-end tests
Tests live in ./tests/e2e
. E2E tests have their own Docker container to run the WordPress server. Start
the server using:
npm run docker:up
Run tests using:
npm run test:e2e-dev
or in headless mode:
npm run test:e2e
Run a single test by adding the file name:
npm run test:e2e-dev complete-onboarding-wizard.test.js
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