Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/drublic/contentful-to-algolia

⚡️ Transmit content from any Contentful type to Algolia indexes
https://github.com/drublic/contentful-to-algolia

algolia api contentful javascript nodejs

Last synced: 29 days ago
JSON representation

⚡️ Transmit content from any Contentful type to Algolia indexes

Awesome Lists containing this project

README

        

# 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 ,
String ,
[Function ],
[String ],
[Function ]
)

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 );

// Sync data
Sync.sync(
String ,
String ,
[Function ],
[String ],
[Function ]
);

## Example config

You can find a sample configuration in [config.sample.js](./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](./LICENSE).