https://github.com/typesense/showcase-federated-search

An app that showcases federated search in Typesense (Open source alternative to Algolia)
https://github.com/typesense/showcase-federated-search

algolia federated-search instantsearch typesense

Last synced: about 1 month ago
JSON representation

An app that showcases federated search in Typesense (Open source alternative to Algolia)

• Host: GitHub
• URL: https://github.com/typesense/showcase-federated-search
• Owner: typesense
• License: apache-2.0
• Created: 2022-04-21T03:17:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-21T03:32:20.000Z (over 2 years ago)
• Last Synced: 2024-08-17T08:07:21.270Z (4 months ago)
• Topics: algolia, federated-search, instantsearch, typesense
• Language: JavaScript
• Homepage: https://federated-search.typesense.org/
• Size: 120 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Federated Search with Typesense

This is a demo that showcases Typesense's Federated or Multi-Search feature.

View it live here: [https://federated-search.typesense.org/](https://federated-search.typesense.org/)

## Dataset

The dataset of company names and usernames was [generated](https://github.com/typesense/showcase-federated-search/blob/master/scripts/indexData.js) using faker.js.

## Tech Stack

This search experience is powered by Typesense which is a fast, open source typo-tolerant search-engine. It is an open source alternative to Algolia and an easier-to-use alternative to ElasticSearch.

The app was built using the [Typesense Adapter for InstantSearch.js](https://github.com/typesense/typesense-instantsearch-adapter) and is hosted on Cloudflare Pages.

The search backend is powered by a geo-distributed 3-node Typesense cluster running on [Typesense Cloud](https://cloud.typesense.org), with nodes in Oregon, Frankfurt and Mumbai.

## Repo structure

- `src/` and `index.html` - contain the frontend UI components, built with Typesense Adapter for InstantSearch.js

- `scripts/` - contains the scripts to extract, transform and index the data into Typesense.

## Development

1. Create a `.env` file using `.env.example` as reference.

2. Generate and index data

  ```shell

  yarn indexData

  ```

4. Install dependencies and run the local server:

```shell

yarn

yarn start

```

Open http://localhost:3000 to see the app.

## Deployment

The app is hosted on Cloudflare Pages and is set to auto-deploy on git push