This repository links to the Algolia application with the ID of "853MYZ81KY". It relies on certain settings, rules, data and events/analytics being present in this Algolia application.
There are two private functions running in AWS (in the solutions organisation) in order to assist with the above functions:
-
Flagship-settings-manager: responsible for resetting rules, synonyms and settings every hour.
-
Flagship-traffic-generator: responsible for generating fake traffic for analytics purposes.
We require one more function (currently in development), for generating the correct events in order to feed our AI models such as frequently bought together. Currently these models are hardcoded.
We use Commitlint with a conventional configuration, this is enforced using a hook via Husky
Instance | Branch | Description, Instructions, Notes |
---|---|---|
Stable | master | Accepts merges from Next and Hotfixes |
Next | next | Accepts merges from Features/Issues |
Features/Issues | topic-* | Always branch off HEAD of Stable |
Hotfix | hotfix-* | Always branch off Stable |
You can find the correct template in /PULL_REQUEST_TEMPLATE.md, please adhere to this convention.
All PR's must be tested and subsequently approved by at least one Algolia engineer (a member of the demo engineering team if possible).
Where possible, attach an issue to a PR so it's clear what we are solving. If there is no issue, create one before submitting the PR.
This demo serves to show Algolia in action.
To run this project locally, install the dependencies and run the local server:
npm install
npm start
Alternatively, you may use Yarn:
yarn install
yarn start
Open http://localhost:1234 to see your app.
Please provide the following environment variables before deploying: When Goes public use Environment Variables
- new features should be developed on a new branch and then merged into
next
master
consists of the latest stable version of the application in productionnext
is akin to the next beta release and should be used for testingnext
is pushed to master on a continuous basis, defined by each sprints output
📙 Documentation :
- Personalised Carousel
- Autocomplete
✅ Autocomplete with multiple index
- RefinementList
- Current refinement
- Content Injection
- Guided Navigation
✅ Refinement list Connector Widget
✅ Predictive Search & Query suggestions
- Related items
- Banner Injection
- Clear Refinement
- Stats
- Smart SortBy
- Pagination
- Range Slider
- Color / Visual Facets
- Routing
- Federated Search
- VoiceSearch
- Insight event