Skip to content

Latest commit

 

History

History
131 lines (81 loc) · 5.49 KB

README.md

File metadata and controls

131 lines (81 loc) · 5.49 KB
Raw

Pinterest for WooCommerce

PHP Unit Tests JavaScript Unit Tests PHP Coding Standards - PR Changed Files JavaScript and CSS Linting

A native integration which allows you to market your store on Pinterest, including:

Status - in development

Pinterest for WooCommerce is under development. To find out more about availability and release, refer to WooCommerce.com.

Support

This repository is not suitable for support. Please don't use our issue tracker for support requests.

Requirements

Pinterest for WooCommerce requires recent versions of PHP (7.3 or newer), and WordPress and WooCommerce (we recommend the latest, and support the last two versions, a.k.a. L-2).

See pinterest-for-woocommerce.php for current required versions.

Supported browsers

As per WordPress Core Handbook we currently support:

  • Last 1 Android versions.
  • Last 1 ChromeAndroid versions.
  • Last 2 Chrome versions.
  • Last 2 Firefox versions.
  • Last 2 Safari versions.
  • Last 2 iOS versions.
  • Last 2 Edge versions.
  • Last 2 Opera versions.
  • Browsers with > 1% usage based on can I use browser usage table

⚠️ We do not support Internet Explorer.

Development

After cloning the repo. Remember to use the appropriate node version

  • nvm use to autoselect the node version based on .nvmrc file.

Then, install dependencies:

  • npm install to install JavaScript dependencies.
  • composer install to gather PHP dependencies.

Now you can build the plugin using one of these commands:

  • npm start: Build a development version and watch files for changes.
  • npm build: Build a production version.
  • npm build:zip: Build and production version and package as a zip file.

Branches

  • develop branch is the most up-to-date code.

Development tools

There are a number of development tools available as npm scripts. Check the package.json file for more.

  • npm run lint:js: Run eslint to validate JavaScript code style.
  • npm run lint:css: Run stylelint to validate CSS code style.
  • npm run lint:php: Run phpcs to validate PHP code style.

Please use these tools to ensure your code changes are consistent with the rest of the code base. This code follows WooCommerce and WordPress standards.

This repository includes an EditorConfig to automate basic code formatting. Please install the appropriate plugin for your editor.

PHPUnit

Prerequisites

Install composer, git, svn, and either wget or curl.

Change to the plugin root directory and type:

$ composer install

Install Test Dependencies

To run the unit tests you need WordPress, WooCommerce, and the WordPress Unit Test lib (included in the core development repository).

Install them using the install-wp-tests.sh script:

$ ./bin/install-wp-tests.sh <db-name> <db-user> <db-pass> <db-host>

Example:

$ ./bin/install-wp-tests.sh wordpress_tests root root localhost

This script installs the test dependencies into your system's temporary directory and also creates a test database.

You can also specify the path to their directories by setting the following environment variables:

  • WP_TESTS_DIR: WordPress Unit Test lib directory
  • WP_CORE_DIR: WordPress core directory
  • WC_DIR: WooCommerce directory

Running Tests

Change to the plugin root directory and type:

$ vendor/bin/phpunit

The tests will execute, and you'll be presented with a summary.



Made with 💜 by WooCommerce.
We're hiring! Come work with us!