Download the PHP package spatie/laravel-server-side-rendering without Composer
On this page you can find all versions of the php package spatie/laravel-server-side-rendering. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-server-side-rendering
More information about spatie/laravel-server-side-rendering
Files in spatie/laravel-server-side-rendering
Package laravel-server-side-rendering
Short Description Server side rendering JavaScript in your Laravel application
License MIT
Homepage https://github.com/spatie/laravel-server-side-rendering
Informations about the package laravel-server-side-rendering
Server side rendering JavaScript in your Laravel application
Making server side rendering a bit less hard in Laravel.
This package is a Laravel bridge for the spatie/server-side-rendering library. Before getting started, dig through the readme to learn about the underlying concepts and caveats. This readme also assumes you already have some know-how about building server rendered JavaScript apps.
Vue and React example apps are available at spatie/laravel-server-side-rendering-examples if you want to see it in action.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
The service provider and Ssr
alias will be automatically registered.
You can optionally publish the config file if you want to tweak things.
Usage
Prerequisites
First you'll need to pick an engine to execute your scripts. The server-side-rendering library ships with V8 and Node engines. By default, the package is configured to use node, since you probably already have that installed on your system.
Set up the NODE_PATH
environment variable in your .env file to get started:
You'll also need to ensure that a storage/app/ssr
folder exists, or change the ssr.node.temp_path
config value to something else.
If you'd rather use the V8 engine, you can skip the previous two steps. You'll need to have the v8js extension installed though.
Configuration
Besides the above, no configuration's required. If you need to tweak things anyway, the config file is well documented.
Setting up your scripts
You'll need to build two scripts: a server script and a client script. Refer to your frontend-framework-of-choice's documentation on how to build those.
The server script should be passed to the ssr
function, the client script should be loaded manually. The package assumes you're using Laravel Mix, and will resolve the path for you. You can opt out of this behaviour by setting mix
to false
in the config file.
Your server script should call a dispatch
function to send the rendered html back to the view. Here's a quick example of a set of Vue scripts for a server-rendered app. Read the spatie/server-side-rendering readme for a full explanation of how everything's tied together.
Rendering an app in your view
The package exposes an ssr
helper to render your app.
A facade is available too.
Rendering options can be chained after the function or facade call.
Available options are documented at spatie/server-side-rendering.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Credits
- Sebastian De Deyne
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-server-side-rendering with dependencies
illuminate/support Version ^10.0|^11.0
spatie/server-side-rendering Version dev-main