You are here

Home » API reference » Search API Algolia 8

README.txt in Search API Algolia 8

Same filename and directory in other branches
  1. 7 README.txt
  2. 2.0.x README.txt
CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Known problems
 * Maintainers
 * Dependencies


INTRODUCTION
------------
This module provides integration with the Algolia service
(https://www.algolia.com), through Drupal's Search API. This module is intended
to be used by developers, as it does not currently provide any implementation of
an actual search interface. Only indexing is currently supported. As a result,
enabling that module will not have any visible effect on your application.
Search functionality may be implemented using the Algolia Javascript API.

Currently supported:
 * initial indexing of entities (see "Know problems")
 * re-indexing on node updates or through forced re-index action

Type of fields which have been successfully tested:
 * entity reference fields (either single or multivalued)
 * standard text fields containing either strings or integers (integer support
   is important for comparison functions in the search query)
 * geofield, address field components


REQUIREMENTS
------------
This module requires the following modules:
 * Search API (https://www.drupal.org/project/search_api)

This module also uses the following library:
 * Algolia search client PHP library
   https://github.com/algolia/algoliasearch-client-php
   add via `composer require algolia/algoliasearch-client-php`


INSTALLATION
------------
Please refer to the INSTALL.txt file.


KNOWN PROBLEMS
--------------
Please report problems.


MAINTAINERS
-----------

Current D7 maintainers:
Matthieu Bergel (mbrgl) - https://www.drupal.org/user/489214

Current D8 maintainers:
Jens Beltofte (beltofte) - https://www.drupal.org/u/beltofte
Christopher Calip (chriscalip) - https://www.drupal.org/u/chriscalip
Nikunj Kotecha (nikunjkotecha) - https://www.drupal.org/u/nikunjkotecha

The initial Drupal 7 development of this module has been sponsored by
TroisCube (http://www.troiscube.com).

The initial Drupal 8 development of this module has been sponsored by FDM.dk
and FFWagency.com

DEPENDENCIES
------------
This module requires an account on https://www.algolia.com, where you will be
able to generate the required Application ID and API key. A 14-day free trial
period is granted with every new account.

Pricing options can be found on the Algolia website:
https://www.algolia.com/pricing

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Known problems

  7.  * Maintainers

  8.  * Dependencies

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. This module provides integration with the Algolia service

  14. (https://www.algolia.com), through Drupal's Search API. This module is intended

  15. to be used by developers, as it does not currently provide any implementation of

  16. an actual search interface. Only indexing is currently supported. As a result,

  17. enabling that module will not have any visible effect on your application.

  18. Search functionality may be implemented using the Algolia Javascript API.

  19. 

  20. Currently supported:

  21.  * initial indexing of entities (see "Know problems")

  22.  * re-indexing on node updates or through forced re-index action

  23. 

  24. Type of fields which have been successfully tested:

  25.  * entity reference fields (either single or multivalued)

  26.  * standard text fields containing either strings or integers (integer support

  27.    is important for comparison functions in the search query)

  28.  * geofield, address field components

  29. 

  30. 

  31. REQUIREMENTS

  32. ------------

  33. This module requires the following modules:

  34.  * Search API (https://www.drupal.org/project/search_api)

  35. 

  36. This module also uses the following library:

  37.  * Algolia search client PHP library

  38.    https://github.com/algolia/algoliasearch-client-php

  39.    add via `composer require algolia/algoliasearch-client-php`

  40. 

  41. 

  42. INSTALLATION

  43. ------------

  44. Please refer to the INSTALL.txt file.

  45. 

  46. 

  47. KNOWN PROBLEMS

  48. --------------

  49. Please report problems.

  50. 

  51. 

  52. MAINTAINERS

  53. -----------

  54. 

  55. Current D7 maintainers:

  56. Matthieu Bergel (mbrgl) - https://www.drupal.org/user/489214

  57. 

  58. Current D8 maintainers:

  59. Jens Beltofte (beltofte) - https://www.drupal.org/u/beltofte

  60. Christopher Calip (chriscalip) - https://www.drupal.org/u/chriscalip

  61. Nikunj Kotecha (nikunjkotecha) - https://www.drupal.org/u/nikunjkotecha

  62. 

  63. The initial Drupal 7 development of this module has been sponsored by

  64. TroisCube (http://www.troiscube.com).

  65. 

  66. The initial Drupal 8 development of this module has been sponsored by FDM.dk

  67. and FFWagency.com

  68. 

  69. DEPENDENCIES

  70. ------------

  71. This module requires an account on https://www.algolia.com, where you will be

  72. able to generate the required Application ID and API key. A 14-day free trial

  73. period is granted with every new account.

  74. 

  75. Pricing options can be found on the Algolia website:

  76. https://www.algolia.com/pricing