Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.29 KB

README.md

File metadata and controls

31 lines (18 loc) · 1.29 KB

String locator

Find and edit code or texts in your themes plugins or anywhere within the WordPress directory.

Contributing

Contributions are both encouraged, and very welcome.

Setting up a local environment

The project makes use of wp-env for a local testing environment, composer for PHP dependencies (such as phpunit), and npm for the package manager wrapper.

  • Set up composer composer install
  • Set up build dependencies npm install

That's it for the basics, you're now ready to make changes to the codebase!

Ready to test your changes? Wonderful!

Start by building the project:

  • npm run build

Once that's done, you should have a new directory named string-locator which holds the ready to use plugin.

If you have your own testing setup, you may use that now, if not, using wp-env is a convenient way to test the plugin.

  • npm run wp-env start will start the environment on http://localhost:8888
  • npm run wp-env stop stops the environment

If you are familiar with wp-env already, you may call any of its functions using npm run wp-env [command], or read more about wp-env in the WordPress Developers handbook