Quickstart for BackstopJS

A Wordpress plugin to get testing quickly with BackstopJS.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• An up-to-date Wordpress install
• BackstopJS (how to install)

Installing

Download the repo

• Download the repository to your wp-content/plugins directory
• Extract the zip
• Rename the folder to quickstart-for-backstopjs

Clone the repo

Clone the repository to your wp-content/plugins directory

• Go to your plugins directory cd wp-content/plugins
• Clone the repo into the directory

Testing

Manual Testing

To test the plugin:

• Create a new WP install
• Install test data from wptest.io
• Initialise BackstopJS
• Go to the plugin in wp-admin -> tools -> backstopjs
• To ensure hideSelectors is working, add .gallery img to hide the changing gallery images
• Copy the outputted config to backstop.json
• Run BackstopJS tests
• Confirm your output works

Automated Testing

Coming soon

Contributing

We're using Gitflow.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Christof Lee - Initial work - PurpleBooth

License

This project is licensed under the MIT License - see the LICENSE.md file for details