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: 30 days ago
JSON representation

⚡️ Transmit content from any Contentful type to Algolia indexes

• Host: GitHub
• URL: https://github.com/drublic/contentful-to-algolia
• Owner: drublic
• License: mit
• Created: 2017-01-15T17:05:49.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T15:21:40.000Z (almost 2 years ago)
• Last Synced: 2024-05-13T17:43:50.155Z (6 months ago)
• Topics: algolia, api, contentful, javascript, nodejs
• Language: JavaScript
• Size: 187 KB
• Stars: 54
• Watchers: 4
• Forks: 11
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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