Code Monkey home page Code Monkey logo

algolia-woo-indexer's Introduction

Scrutinizer Code Quality PHP Linter

Screenshot

Algolia WooCommerce Indexer

Description

This plugin transfers products from WooCommerce to Algolia. You can choose if it only sends products that are in stock.

You need to add the Application ID, the Admin API Key from the API keys section in Algolia as well as the Index Name.

Note that this plugin is designed for developers developing headless Ecommerce solutions.

Important notice: This plugin will NOT submit products without a category.

Basic Features

  • Manually or automatically submit WooCommerce products to Algolia
  • Default options are added upon plugin activation
  • Options are deleted from database upon plugin uninstallation (not on deactivation)

Advanced Features

  • POT file for translations is included
  • All code scanned and verified with PHPCS
  • Code follows modern coding standards
  • All variables are properly sanitized to ensure that no security issues are present

Requirements

  • An account at www.algolia.com (can be a free community plan)
  • Access to install and activate plugins (usually administrator rights)
  • WordPress 5.5
  • WooCommerce 5.0.0
  • PHP 7.3
  • PHP extensions/functions enabled: mbstring, mbregex and cURL
  • All products MUST have a category assigned (Uncategorized is not a category), or they will not be submitted

Installation

  • Login to WordPress as Admin
  • Upload Algolia Woo Indexer to the /wp-content/plugins/ directory of your application
  • Activate the plugin through the Plugins menu in WordPress
  • Login to Algolia and go to API keys and copy or write down the Application ID and the Admin API Key
  • Go back to WordPress and access plugin settings under Settings->Algolia Woo Indexer
  • Add the Application ID to the plugin settings page
  • Add the Admin API Key to the plugin settings page
  • Add the name of the index that should be used to index WooCommerce products
  • Click on the Send products with Algolia button to send the products to Algolia

Troubleshooting

If you encounter any errors, first of all make sure that your hosting environment meets the requirements listed under Requirements.

Feel free to open an issue and I will do my best to troubleshoot and assist.

TODO

  • Upgrade Algolia package and check that it works correctly

algolia-woo-indexer's People

Contributors

w3bdesign avatar dependabot-preview[bot] avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.