https://github.com/vhscom/hyperdrive
🚀 The fastest way to load pages in WordPress. Mirror of Hyperdrive on Codeberg. :point_down:
https://github.com/vhscom/hyperdrive
fetch-api fetch-inject javascript performance php wordpress-plugin
Last synced: about 1 month ago
JSON representation
🚀 The fastest way to load pages in WordPress. Mirror of Hyperdrive on Codeberg. :point_down:
- Host: GitHub
- URL: https://github.com/vhscom/hyperdrive
- Owner: vhscom
- License: agpl-3.0
- Created: 2022-02-19T06:05:26.000Z (over 4 years ago)
- Default Branch: trunk
- Last Pushed: 2022-02-19T06:05:52.000Z (over 4 years ago)
- Last Synced: 2025-03-11T09:17:41.690Z (about 1 year ago)
- Topics: fetch-api, fetch-inject, javascript, performance, php, wordpress-plugin
- Language: PHP
- Homepage: https://codeberg.org/vhs/hyperdrive
- Size: 4.27 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# Hyperdrive
> The fastest way to load pages in WordPress.
[](https://codecov.io/gh/vhs/hyperdrive)
Hyperdrive is a WordPress plugin that increases site performance using [modern Web standards](https://fetch.spec.whatwg.org/). Based on initial testing Hyperdrive [has been shown](https://hackernoon.com/putting-wordpress-into-hyperdrive-4705450dffc2) to reduce perceived latency in the Twenty Seventeen theme by 200-300%.
Translations: [Pу́сский](docs/README_ru.md), [Español](docs/README_es-419.md), [Português](docs/README_pt-br.md)
## How it works
Hyperdrive uses a performance optimization technique known as [Fetch Injection](https://hackcabin.com/post/managing-async-dependencies-javascript/) available in [supported browsers](http://caniuse.com/#search=fetch). Fetch Injection leverages [Fetch](https://github.com/whatwg/fetch), the modern replacement for Ajax.
## Installation
Several installation options are available. Choose the one which best meets your skill level and desired workflow.
### Ensign
To install the plugin manually, simply:
1. Upload `hyperdrive.php` to the `/wp-content/plugins/` directory,
1. Activate the plugin through the *Plugins* menu in WordPress.
### Lieutenant
To install and manage with [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) run the following from the WP installation directory:
composer require vhs/hyperdrive:1.0.x-dev
The above will download the Hyperdrive beta under version control and install it directly to the `/wp-content/plugins` directory. Run `composer update` to get the new and shiny.
### Commander
The only thing here you may not recognize is [`rupa/z`](https://vhs.codeberg.page/post/installing-using-rupaz-shell-script/):
```shell
ssh user:pass@wordpressbox.tld
z plugins
curl -O https://code.vhs.codeberg.page/vhs/hyperdrive/raw/branch/trunk/src/hyperdrive.php
wp plugin activate hyperdrive
```
## Todo before 1.0.0 release candidates
- [ ] Only dequeue scripts if [browser supports Fetch](http://caniuse.com/#search=fetch) for backwards compatibility with older browsers
- [ ] Integrate localization behaviors [as shown here](https://gist.github.com/vhs/64e8380010e43a526fb9c9ee511fad17#file-functions-php-L507).
- [ ] Test with a few different themes and open bugs and needed
## Contributing
Hundreds of thousands of individuals and users rely on WordPress every day to consume and share information online. For that reason Hyperdrive has strict requirements for code contributions.
And though Hyperdrive may have a high bar for quality, please don't let that deter you from making contributions. We take on all comers.
Where possible project owners, collaborators and contributors should embrace the [values of the Agile Manifesto](https://pragdave.me/blog/2014/03/04/time-to-kill-agile.html):
> - **Individuals and Interactions** over Processes and Tools
> - **Working Software** over Comprehensive Documentation
> - **Customer Collaboration** over Contract Negotiation, and
> - **Responding to Change** over Following a Plan
### Issues
Hyperdrive accepts any issue. Be it gratuitously worded, devoid of information or just plain dumb. Feedback is a gift and will be treated as such. No question is stupid, even the stupid ones.
### Pull requests
Please open issues when creating PRs and PR against the issue to close it. This establishes a need (the issue) and helps separate the need from the implementation (the pull), resulting in more robust solutions.
Before working on a pull please install and configure [EditorConfig](http://editorconfig.org/) for your editor or IDE to help normalize your code syntax with that of the project.
## License
[](https://code.vhs.codeberg.page/vhs/hyperdrive/src/branch/trunk/COPYING)