Skip to content

algolia/flagship_fashion_demo

Repository files navigation

FASHION DEMO FOR RETAILERS

Fashion demo

⭐️ Dependancies

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:

  1. Flagship-settings-manager: responsible for resetting rules, synonyms and settings every hour.

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

⭐️ How to contribute

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

Pull Requests

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.

Flagship Fashion Demo

This demo serves to show Algolia in action.

⭐️ Get started

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.

⭐️ Configuration

Please provide the following environment variables before deploying: When Goes public use Environment Variables

⭐️ Branches

  • 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 production
  • next is akin to the next beta release and should be used for testing
  • next is pushed to master on a continuous basis, defined by each sprints output

⭐️ Dependancies

⭐️ Algolia s features implemented & docs

📙 Documentation :

  • Personalised Carousel

Dynamic content Carousel

Personalised Carousel

  • Autocomplete

Autocomplete Documentation

Autocomplete Widget

Autocomplete with multiple index

  • RefinementList

Refinement List

  • Current refinement

Current Refinement

  • Content Injection

Project Tutorial

Dashboard Tutorial

  • Guided Navigation

Refinement list Connector Widget

Predictive Search & Query suggestions

  • Related items

Related Items

  • Banner Injection

Content Injection Banner

  • Clear Refinement

Clear Refinement Widget

  • Stats

Display Search Statistics

  • Smart SortBy

Smart Sort (Beta)

  • Pagination

Pagination

Pagination 2

  • Range Slider

Range Slider

  • Color / Visual Facets

Handle Visual Facets

  • Routing

Route your app

  • Federated Search

Federated Search Dropdown

  • VoiceSearch

VoiceSearch

  • Insight event

Send events to analytics

About

No description, website, or topics provided.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published