Skip to content

Latest commit

 

History

History
126 lines (66 loc) · 5.61 KB

README.md

File metadata and controls

126 lines (66 loc) · 5.61 KB
Raw

Save and Share Cart for WooCommerce

1. Overview

2. Usage/Installation

3. Prerequisites for plugin to work

4. Plugin settings

5. Translating the plugin

Save and Share Cart for WooCommerce is a WordPress plugin which enabled woocommerce customers to:

  • Share cart on various social media platforms like Facebook, Twitter, WhatsApp etc.
  • Email the cart to someone else.
  • Save the cart for later reference or checkout. (Only logged-in users)

Save and share cart can be useful in following situations:

  1. It allows customers to share cart with other people with similar interest.

  2. Other people can perform checkout directly after viewing shared cart. No more hustle of finding,viewing and adding products to the cart.

  3. Saved carts can be used as wishlist-type.

  4. Useful to take support from customer care by sharing carts with them.

  5. Adding links to newsletters, ads or communications to quickly add products or sets of products to customers’ carts with one click. Increasing sales!

Usage/Installation

  1. Clone this repository in plugnis directory of wordpress.

  2. Move to share-cart directory and run composer install && composer dump-autoload -o. This will install all dependecies and will create classmap.

  3. cd assets/js and run npm i. This will create all the necessary build files.

  4. Go to WordPress dashboard in Plugins > Installed plugins and activate the plugin.

Prerequisites for plugin to work

  1. This plugin uses reCaptcha v2 (checkbox) for preventing attacks from bots which may abuse Save and Email features of the plugin. You must register the site with Google Recaptcha v2 (Tickbox). You can register the site for recaptcha here: https://www.google.com/recaptcha/admin/create

  2. In order for email to work, Email body field should be filled appropriately under Email settings tab (Described below).

Plugin Settings Page

Plugin settings options can be accessed via WooCommerce settings tab. Go to WooCommerce > Settings > Share Cart from your wordpress dashboard. Please note that these settings options would be accessible to only those with shop_manager capability in WordPress.

Following is the description of each settings tab in settings page.

1. General Settings

Cart Share Settings

  • Share button position - Select the position where you want to render the Share cart button. There are number of options available from which you can choose button placement.

  • Share cart button text - Button text to render.

  • Shared cart page title - If the cart does not have any title. This title will be used by default for the cart.

Enable social media for sharing

Select the social media platforms on which you want to allow your customers to share the cart. It includes following social media platforms:

  • Facebook
  • Twitter
  • Skype
  • WhatsApp

Apart from it, you can also allow them to Email and Save cart. Copy cart link to clipboard option is also there if they want to share the cart on some other platforms.

Miscellaneous

  • Captcha key - This is important and required option. you need to register for reCaptcha v2 as the site uses Captcha to prevent from bot attacks.

2. Email Settings

  • Email from address (optional) - If someone emails the cart, this address will be used as from address in email.
  • Email from name (optional) - Used as from name in email.
  • Email body (Required) - This will be sent as email body. There are several placeholders which can be used and will be replaced by appropriate data at the time of email being sent.

These placeholdres are:

{cart_link} - Link of the cart being shared.

{blogname} - Name of WordPress site.

{siteurl} - URL of WordPress blog.

3. Save cart settings

  • Saved cart title - This will be shown as navigation item title inside My accounts page.

Saved cart title

5. Localization

You can translate the plugin in your language with the following steps.

Consider you need to translate the plugin to Polish language (pl_PL)

  1. Fork this repo, clone your forked repository in your system and create a new branch with git checkout -b branch-name

  2. Go to share-cart/languages directory, create a new directory pl_PL (Same as locale).

  3. Run cp wcssc.pot pl_PL/wcssc-pl_PL.po. This will create a .po inside pl_PL directory.

  4. Open wcssc-pl_PL.po with poedit or any other software and translate the strings. Save the .mo file inside languages/pl_PL directory. .mo file name should be wcssc-pl_PL.mo (for this example).

  5. Now, to translate JS string, you should run move to share-cart repository (Root of this repo). Run npm install. This will install jed and po2json for you.

  6. Run command from root of the repo in terminal, npx po2json languages/wcssc-js.po languages/pl_PL/wcssc-pl_PL-wcssc-main.json -p -f jed1.x. Note that for other languages it should be in format wcssc-{$locale}-wcssc-main.json

  7. Once the .json file is created, add the translation to that json file.

Once all the above steps are completed, commit and push the changes to your repository. Create a PR from your repo to this repo. For more information on how to create PR for someone else's repo, please refer this link