Skip to content
⚡️ Transmit content from any Contentful type to Algolia indexes
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.editorconfig
.eslintrc.json
LICENSE
README.md
config.sample.js
index.js
package.json
yarn.lock

README.md

Transmit data from Contentful to Algolia

The application syncs content between Contentful and Algolia. You can configure the service to run with Drafts (Preview API) from Contentful and put it in different indexes in Algolia. The prefix of each index can be configured.

Install the module

npm install --save contentful-to-algolia

Documentation

The main method of Sync:

sync(
  Array <types>,
  String <indexName>,
  [Function <callback>],
  [String <entryId>],
  [Function <manipulateSingle>]
)

Sync multiple content types from Contentful to Algolia

Usage

// Require module
const ContentfulToAlgolia = require('contentful-to-algolia');

// Generate new instance
const Sync = new ContentfulToAlgolia(Object <config>);

// Sync data
Sync.sync(
  String <type>,
  String <indexName>,
  [Function <callback>],
  [String <entryId>],
  [Function <manipulateSingle>]
);

Example config

You can find a sample configuration in config.sample.js.

Todo

  • Remove elements which are not used anymore
  • Use Contentful's Syncronisation API
  • Tests

License

This project is under MIT license, 2017, ⓒ Hans Christian Reinl. Read more in LICENSE.

You can’t perform that action at this time.