Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 5.16 KB

README.md

File metadata and controls

83 lines (51 loc) · 5.16 KB

Welcome to the WP Rocket GitHub Repository

Unit/Integration tests

Feel free to browse the source and keep track of our plugin's progress. You can stay informed of our latest versions via our blog or via Twitter @wp_rocket.

We aim to help make the web faster, one WordPress website at a time. That’s why we created WP Rocket. It's a caching plugin that simplifies the process and helps decrease a website’s load time.

If you are not a developer, visit our documentation.

Documentation

Need detailed setup instructions?

We are very proud of WP Rocket’s knowledge base. We have documentation in English and French.

You can also check out our changelog.

Composer installation

You can use composer to install the plugin as a dependency:

composer require wp-media/wp-rocket

To be able to validate your license and use the plugin, you will also have to manually define 2 constants in your wp-config.php file:

  • WP_ROCKET_EMAIL which is the email for your WP Rocket account
  • WP_ROCKET_KEY which is your API Key

Gulp Tasks

Command Description
CSS Tasks
gulp build:saas:unmin Builds Full admin CSS, the unminified version (wpr-admin.css)
gulp build:saas:min Builds Full admin CSS, the minified version (wpr-admin.min.css)
gulp build:sass:all Builds all admin CSS files (wpr-admin.css, wpr-admin.min.css, wpr-admin-rtl.css, wpr-admin-rtl.min.css)
gulp sass:watch Watches all admin CSS files mentioned above and builds them again with any change.
JS Tasks
gulp build:js:app:unmin Builds admin app js file, the unminified version (wpr-admin.js)
gulp build:js:app:min Builds admin app js file, the minified version (wpr-admin.min.js)
gulp build:js:lazyloadcss:min Builds lazyload CSS js file, the minified version (lazyload-css.min.js)
gulp build:js:all Builds all js files mentioned above (wpr-admin.js, wpr-admin.min.js, lazyload-css.min.js, wpr-beacon)
gulp build:js:beacon Builds beacon script (wpr-beacon.min.js, source file, and map file)
gulp js:watch Watches all js files changes and build them again with any change.

Support

Need help with something? Open a ticket and we will be happy to help you out!

Bugs

If you find an issue in WP Rocket, please let us know here. Be advised, this point of contact is to be used to report bugs and not to receive support. Check out our support page if you need to submit a ticket.

Security Policy

Reporting Security Bugs

You can report any security bugs found in the source code of the site-reviews plugin through the Patchstack Vulnerability Disclosure Program. The Patchstack team will assist you with verification, CVE assignment and take care of notifying the developers of this plugin.

Contributions

Feel free to check out our GitHub issues if you would like to request a feature. We always look forward to feedback and suggestions from the community to help us improve our plugins!

Want to know more about our WordPress plugins?

Visit wp-media.me.

We also make other plugins that help speed up WordPress websites. Check out:

  • Imagify: it's a great WordPress plugin to optimize your images and speed up your website.

Special thanks

Thank you BrowserStack for your support and helping us do cross-browser testing easily!

BrowserStack