@builder.io/plugin-algolia
v0.0.5
Published
By syncing your Builder content to Algolia, you can easily add super-charged search of your product data, landing pages or even custom data models.
Downloads
23
Maintainers
Keywords
Readme
Builder.io Algolia plugin
By syncing your Builder content to Algolia, you can easily add super-charged search of your product data, landing pages or even custom data models.
Installation
Go to builder.io/account/organization and add the plugin from the plugin settings (@builder.io/plugin-algolia
)
The page will reload, asking you to enter in your Algolia account credentials. You can find your Account Id in the URL of the Algolia dashboard or in the top left of your dashboard:
https://www.algolia.com/apps/<account-id>/dashboard
You'll need to create an Algolia API key and ensure that it has the correct ACL permissions, most importantly addObject
, deleteObject
and search
.
Here's an example of the permissions you'll want to enter on the Create API Key form located at www.algolia.com/apps/<your-account-id>/api-keys/restricted
:
Syncing Model Data
Now that you have the plugin set up, you can start syncing your model content. First, head over to the Builder Model that you want to sync.
Click the More Options button above the model fields, then you'll see a button at the bottom of the Show More Options section, click this button and your existing content will automatically be sent to Algolia with the index name builder-modelName
.
Adding Algolia Search Inputs via Builder
We have plans to add pre-built Search interfaces to the plugin, in the meatime, you can use the Algolia APIs or a library like InstantSearch