This is an example blog that demonstrates how you can integrate Algolia Search indexes populated from published content in Dynamic Content.
A requirement for running this demo application is that a blogpost content item must have been published from Dynamic Content and indexed within Algolia. The rendering templates must also have been added to your Content Hub. Following the steps below will get you to this starting point:
- Register the required content types in Dynamic Content: Content Types | Docs.
- Create an integration between Dynamic Content and Algolia: dc-integrations-algolia.
- In Dynamic Content, create a content item using the previously registered blogpost content type. Once created, publish the content item. This will then add it to your Algolia index.
- Add the rendering templates to your Content Hub: HTML Templates | Docs
Checkout this repo and install the dependencies via npm:
npm install
The below command will run unit tests for the project:
npm run test
Configuration values required to run the application should be saved in a .env file within the root of the project. Example is shown below:
| Parameter | Example Value | Required | Where to find it |
|---|---|---|---|
| ALGOLIA_APPLICATION_ID | ABCDEF1234 | true | Taken from the 'API Keys' page on the Algolia site. |
| ALGOLIA_INDEX_NAME | my-index-name | true | You can use an existing Algolia index name, or you can use a new name here and it will be created automatically if it doesn't exist. |
| ALGOLIA_SEARCH_API_KEY | 0123456789abcdef0123456789abcdef | true | Taken from the 'API Keys' page on the Algolia site. This needs to be the Search key. |
| DC_BLOG_POST_RENDERING_TEMPLATE | acc-template-blogPost | true | The name of your rendering template uploaded to Content Hub (without the file extension) |
| DC_RENDERING_SERVICE_ACCOUNT_ID | my-rendering-svc-id | true | Replace this with your company tag. You can find this by looking at the dynamic URL of an asset published in Content Hub |
You can override the Dynamic Content API and Amplience Auth URLs by defining these optional environment variables:
| Parameter | Example Value | Required | Where to find it |
|---|---|---|---|
| DC_RENDERING_SERVICE_BASE_URL | alternative-rendering-service-base-url | false | Alternative rendering service base url |
| DC_RENDERING_SERVICE_STAGING_DOMAIN | rendering-service-domain | false | Dynamic Content Virtual Staging Environment domain |
| NUMBER_OF_SEARCH_RESULTS | 9 | false | Number of search results to display on the landing page: default = 9 |
These optional variables should be removed completely if they are not required.
To run this application locally, run the following (default port is 3000)
npm run dev
To run the application on a different port
npm run dev -- --port 8080
Click on the button below to deploy this repository to Netlify
If you would like to contribute to this project, please follow our contributing guide.
This software is licensed under the Apache License, Version 2.0,
Copyright 2019 Amplience
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.