friendzy / sylius-plugin
Your customers shop together with their friends, live on your store.
Package info
github.com/getfriendzy/sylius-plugin
Type:sylius-plugin
pkg:composer/friendzy/sylius-plugin
Requires
- php: ^8.2
- sylius/sylius: ^2.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Your customers shop together with their friends, live on your store. They see the same pages and talk it over in a chat or a call. The cart, checkout, account and the other private pages are not shared.
This plugin puts Friendzy on your shop pages and tells Friendzy which pages are private. Friendzy asks each shopper before a shared session starts. The plugin has no consent code of its own, does not connect an account and does not report orders.
Requirements
- PHP 8.2 or newer
- Sylius 2.x (
sylius/sylius^2.0) - The shop layout's head hook,
sylius_shop.base.head(present in the standard Sylius 2 shop theme)
The admin is not touched. A page whose route starts with sylius_admin, or whose path is /admin, gets nothing, even if the template is rendered there.
1. Get your site id
Create a free Friendzy account at https://getfriendzy.com, add your shop's address, and copy the site id Friendzy gives it. A site id looks like site-abcdefghijkl: site- followed by 12 characters from a to z and 2 to 7.
2. Install the plugin
Add the repository to your shop and require the package:
composer config repositories.friendzy vcs https://github.com/getfriendzy/sylius-plugin
composer require friendzy/sylius-plugin
Register the bundle in config/bundles.php:
Swarmsoft\FriendzyPlugin\FriendzyPlugin::class => ['all' => true],
If your shop already prints a Friendzy snippet from its own template, remove it, or the page loads it twice.
3. Set the site id
Add the id to your shop's environment, for example in .env.local:
FRIENDZY_SITE_ID=site-abcdefghijkl
Then clear the cache:
php bin/console cache:clear
An empty value, or a value that is not a valid id, adds nothing to the page. The plugin stores nothing itself and holds no secret: the site id is not a password.
Shoppers see the Friendzy button once Friendzy has checked your shop and you turn on Live for shoppers in your Friendzy admin.
What it adds to the page
While FRIENDZY_SITE_ID holds a valid id, the head of each shop page gets:
<meta name="friendzy-private-paths">naming/cart,/checkout,/account,/login,/register,/orderand/forgotten-password, and the same paths under the current locale (/en_US/cartand so on), because Sylius puts the locale in front of them.<script async src="https://getfriendzy.com/snippet/site-abcdefghijkl.js"></script>
That script then loads Friendzy's own script, styles and images.
FRIENDZY_APP_URL changes where the snippet is loaded from. Leave it unset in a live shop. It accepts only a scheme, a host and an optional port; anything else is ignored and https://getfriendzy.com is used.
What data goes where
The plugin sends nothing by itself. It does not read the customer, the cart or the order, and it does not write to the database.
While a site id is set, the browser loads the snippet. The snippet tells Friendzy that the page loaded: the host, the path and the snippet version. Friendzy keeps one note per page per day, with no cookie and no visitor id.
Friendzy asks each shopper before a shared session. A shopper who does not agree does not join, and nothing about a shared session is sent. No name, email, order total or order line is added by this plugin.
Privacy policy: https://getfriendzy.com/privacy
Uninstall
Remove the bundle line from config/bundles.php, then:
composer remove friendzy/sylius-plugin
Remove FRIENDZY_SITE_ID from your environment and clear the cache. The plugin stored nothing of its own.
Removing the plugin does not close your Friendzy account. To close the site and erase its data, use Close this website in your Friendzy admin. A site Friendzy no longer sees is switched off after 30 days and erased 90 days later.
Tests
No Sylius install is needed:
php tests/run.php
Support
Licence
MIT. See LICENSE. The Friendzy service, and the snippet and widget this plugin loads, are not part of this package.