https://github.com/chec/algolia-integration
An integration to automatically update an Algolia search index when products or categories change
https://github.com/chec/algolia-integration
Last synced: about 1 year ago
JSON representation
An integration to automatically update an Algolia search index when products or categories change
- Host: GitHub
- URL: https://github.com/chec/algolia-integration
- Owner: chec
- License: bsd-3-clause
- Archived: true
- Created: 2021-11-22T19:02:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-15T18:06:53.000Z (over 4 years ago)
- Last Synced: 2025-03-12T10:11:22.436Z (over 1 year ago)
- Language: TypeScript
- Size: 106 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Commerce.js Algolia integration
This repo contains an integration for Algolia, which will automatically update an index when products or categories
change in the Chec API.
## Configuration
This integration requires the following configuration fields:
* Algolia Admin API key, available from your Algolia account's Settings > API keys page
* The Algolia application ID
* The index name to update for products, and categories (default: `products` and `categories`)
## Setup
* Create an Algolia account
* Create an empty index
* Copy your admin API key
* Create the integration in the Chec Dashboard and enter your configuration settings
When this integration runs, it will initially handle the `integrations.ready` event, and use it to sync all products
and categories into your Algolia search indexes. On subsequent runs it will fire on `products.create`,
`categories.update`, etc., and will update or create records in the index as necessary.
## License
See [license](LICENSE.md).