Download the PHP package columbiaroad/wp-ssr without Composer
On this page you can find all versions of the php package columbiaroad/wp-ssr. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download columbiaroad/wp-ssr
More information about columbiaroad/wp-ssr
Files in columbiaroad/wp-ssr
Package wp-ssr
Short Description Server-side rendering for JavaScript apps inside WordPress templates.
License
Homepage https://github.com/ColumbiaRoad/wp-ssr
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wp-ssr
WordPress SSR
Poor man's Server Side Rendering
This application aims to solve server side rendering of JavaScript applications inside WordPress templates. It runs in two parts. First there is the WordPress plugin which creates new post type for the renders and REST API endpoints to get an array of render objects. Secondly there is Express server which when accessed fetches these render objects and launches puppeteer to render the pages. When the page is rendered and the wanted application part of that page is parsed, it will save the html back to the post through the REST API.
Disclaimer
This application doesn't provide you real time server side rendering but it's suitable for better SEO accessibility for your content. The puppeteer renders the page always as unauthenticated user and it requires that the state changes are reflected in the url.
Setup
WordPress
You can install the plugin using composer:
First you need to navigate to the plugin settings and fill in the required information. You need to provide an API key to be used for authenticating with the REST API. Then you need to give WordPress the Node application url what to ping for renders. Last you can define the interval when the renders expire.
In the WordPress template you need to request the rendered content before initial render of the header. You can request the content of the application by using WPSSR\Render::render method which takes in three parameters:
string $urlUrl of the page you are requesting to be renderedstring $app_selectorQuery selector for the application root elementstring $waitfor_selectorQuery selector for the puppeteer to wait before rendering the page
Node App
To start the Node application you need to have couple of environment variables available for it.
WP_DOMAINwhich points to the root of your WordPress installationAPI_KEYis the same API key that you provided in the plugin settings pageNODE_ENVto define the Node environment. This is used in example to ignore puppeteer HTTPS errorsSCHEDULEto define the schedule for rendering cron job
One way to run the application is to use the Docker image provided:
Publishing package
The composer package is automatically published to columbiaroad/wp-ssr when a github release is made.
To publish to dockerhub you need access to the repository there. Publishing is done as follows:
TODO
- [ ] Add
.envfile support for the Node application - [ ] Optimize for large amount of renders
- [ ] Lock the rendering process to prevent multiple simultaneous render calls
