From f34e66f4bf3fc6715e122b145704c86a5bca6dad Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Mon, 30 Jan 2023 10:01:20 -0600 Subject: [PATCH 01/22] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 759bd525..ce38edfb 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ - **Grouping & Distinct:** Group similar results together to show more variety. - **Federated Search:** Search across multiple collections (indices) in a single HTTP request. - **Geo Search:** Search and sort by results around a geographic location. +- **Vector search:** support for both exact & HNSW-based approximate vector searching. - **Scoped API Keys:** Generate API keys that only allow access to certain records, for multi-tenant applications. - **Synonyms:** Define words as equivalents of each other, so searching for a word will also return results for the synonyms defined. - **Curation & Merchandizing:** Boost particular records to a fixed position in the search results, to feature them. From 733389356aa7b0a5d38e9e680ff048199e015cdd Mon Sep 17 00:00:00 2001 From: Joe Paul <11286580+joeirimpan@users.noreply.github.com> Date: Mon, 6 Feb 2023 19:09:25 +0530 Subject: [PATCH 02/22] chore: Add gpura.org to showcase.md --- SHOWCASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SHOWCASE.md b/SHOWCASE.md index 38d416ea..e4c70dd0 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -47,6 +47,7 @@ This is a selection of sites and apps using Typesense. | [MyHearty](https://myhearty.my) | A one-stop charity website to fundraise, donate, volunteer and apply for aids. It comes with a full-featured search UI (instant search, geosearch) for campaigns, volunteer events and aids. | | [Neolace](https://www.neolace.com) | Knowledge graph platform (combines a wiki and a graph database) | | [Project Seldon](https://projectseldon.org) | A free and unbiased analysis platform for understanding societies and systems of government. | +| [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | ### Typesense Demos From 25884e0402d4a1d05af6ac1ef77475bbdda469cb Mon Sep 17 00:00:00 2001 From: Alex Ambarchian Date: Thu, 9 Feb 2023 10:45:14 -0500 Subject: [PATCH 03/22] Add Syracuse University to SHOWCASE.md Hi, I work for Syracuse University's Department of Marketing where we are moving over to typesense for some search functionality on our sites. We have a live demo available! --- SHOWCASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SHOWCASE.md b/SHOWCASE.md index e4c70dd0..5e37a1b0 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -48,6 +48,7 @@ This is a selection of sites and apps using Typesense. | [Neolace](https://www.neolace.com) | Knowledge graph platform (combines a wiki and a graph database) | | [Project Seldon](https://projectseldon.org) | A free and unbiased analysis platform for understanding societies and systems of government. | | [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | +| [Syracuse University](https://syracuse.edu) | A private research university in Syracuse, New York. [Visit our live typesense demo!](https://typesense-demo.dev3.digitalservices.syr.edu) | ### Typesense Demos From d9fb183fe7061683e142cd56b61b647ab5262b88 Mon Sep 17 00:00:00 2001 From: Gorkem Cetin Date: Sat, 18 Feb 2023 14:45:00 -0500 Subject: [PATCH 04/22] Add Magny.io (app search bar) --- SHOWCASE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SHOWCASE.md b/SHOWCASE.md index 5e37a1b0..a29c58dd 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -49,6 +49,8 @@ This is a selection of sites and apps using Typesense. | [Project Seldon](https://projectseldon.org) | A free and unbiased analysis platform for understanding societies and systems of government. | | [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | | [Syracuse University](https://syracuse.edu) | A private research university in Syracuse, New York. [Visit our live typesense demo!](https://typesense-demo.dev3.digitalservices.syr.edu) | +| [Magny SaaS search bar](https://magny.io) | Magny is a SaaS platform that helps implement command palettes, which significantly decreases the time users find anything in your app, leveraging the user experience and efficiency. | + ### Typesense Demos From ad5841d6a0ef3aabeb4f2398e68094f0a05cbcaf Mon Sep 17 00:00:00 2001 From: Sunny Ripert Date: Tue, 7 Mar 2023 16:36:25 +0100 Subject: [PATCH 05/22] Add Cults to Showcase MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit At cults3d.com we are happy users of Typesense Cloud πŸŽ‰ --- SHOWCASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SHOWCASE.md b/SHOWCASE.md index a29c58dd..bf5967ef 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -50,7 +50,7 @@ This is a selection of sites and apps using Typesense. | [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | | [Syracuse University](https://syracuse.edu) | A private research university in Syracuse, New York. [Visit our live typesense demo!](https://typesense-demo.dev3.digitalservices.syr.edu) | | [Magny SaaS search bar](https://magny.io) | Magny is a SaaS platform that helps implement command palettes, which significantly decreases the time users find anything in your app, leveraging the user experience and efficiency. | - +| [Cults.](https://cults3d.com) | Find designs for 3D-printing. *We are very happy with our switch to Typesense, making it a breeze to setup and have pertinent results right from the start* | ### Typesense Demos From 67c858169d15d76fb843e62359c304ec05ba5d52 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Wed, 5 Apr 2023 10:46:16 +0530 Subject: [PATCH 06/22] Update versions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce38edfb..ea77b53e 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ Here's a quick example showcasing how you can create a collection, index a docum Let's begin by starting the Typesense server via Docker: ``` -docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.0 --data-dir /data --api-key=Hu52dwsas2AdxdE +docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.1 --data-dir /data --api-key=Hu52dwsas2AdxdE ``` We have [API Clients](#api-clients) in a couple of languages, but let's use the Python client for this example. @@ -233,7 +233,7 @@ We welcome community contributions to add more official client libraries and int You can use our [InstantSearch.js adapter](https://github.com/typesense/typesense-instantsearch-adapter) to quickly build powerful search experiences, complete with filtering, sorting, pagination and more. -Here's how: [https://typesense.org/docs/0.24.0/guide/#search-ui](https://typesense.org/docs/0.24.0/guide/#search-ui) +Here's how: [https://typesense.org/docs/0.24.1/guide/#search-ui](https://typesense.org/docs/0.24.1/guide/#search-ui) ## FAQ From cb23044a22292804b0fd512e1b19a76adfb10350 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 20 Apr 2023 09:09:25 +0530 Subject: [PATCH 07/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ea77b53e..6f260900 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

- +

From 14f94cdaa2853977759a3395c7750e629d185a0c Mon Sep 17 00:00:00 2001 From: David Paulsson Date: Fri, 16 Jun 2023 13:42:47 +0200 Subject: [PATCH 08/22] Sort showcase in alphabetical order --- SHOWCASE.md | 68 ++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/SHOWCASE.md b/SHOWCASE.md index bf5967ef..4bce23c9 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -10,47 +10,47 @@ This is a selection of sites and apps using Typesense. | Name | Description | | ----------- | ----------- | -| [Read This Twice](https://www.readthistwice.com/) | Book discovery platform uses typesense to power the book/people search | -| [Oddle Eats](https://eats.oddle.me) | Food Delivery Service in Singapore | -| [DiscMaster](http://discmaster.textfiles.com/search) | Search 94 million vintage computer files from archive.org | -| [Dave & Adams Card World](https://www.dacardworld.com) | E-commerce platform for collectibles like sports cards, gaming cards, comics, or autographed memorabilia | -| [Echidna Sewing](https://www.echidnasewing.com.au) | Echidna Sewing is one of Australia’s largest sewing machine dealers | -| [Trading Strategy](https://tradingstrategy.ai/blog/world-fastest-token-search) | Algorithmic trading protocol for decentralised markets | -| [Instatus](https://instatus.com) | System Status Pages Platform | -| [Iconduck](https://iconduck.com) | Site to search for open source icons | -| [Service Foods](https://www.servicefoods.co.nz) | One of New Zealand's largest privately family owned and operated food service distribution businesses | -| [Otaku Square](https://www.otakusquare.com) | Online retailer for pop-culture (e.g. anime, games, movies) merchandise | -| [Orders Made Simple](https://ordersmadesimple.com) | A Stock ordering platform helping to connect hospitality and catering venues with their suppliers | -| [Back Right Up](https://backrightup.com) | Automatic Azure Devops backups | -| [Popcorn](https://onpopcorn.com) | Zoom meets Snapchat, async video chat app | -| [Rushtix](https://rushtix.com) | Live Comedy Shows platform | -| [What's In My Jar](https://whatsinmyjar.com) | Skincare Research platform | -| [GlobalTill](https://www.globaltill.com) | Omnichannel Retail Management System | -| [Upnext](https://www.getupnext.com) | Save, organize and focus on your personal content library | -| [Plaza](https://www.useplaza.com) | Live-shopping platform | | [Aviyel](https://aviyel.com) | Open-source community platform | -| [Grafikart](https://www.grafikart.fr/) | Learning resources library | +| [Back Right Up](https://backrightup.com) | Automatic Azure Devops backups | | [BetaSeries](https://www.betaseries.com/) | TV shows and movies recommendation, using Typesense to search into 4M+ international records | -| [New York University Databrary](https://nyu.databrary.org/) | Video documentation library | -| [ElbiseBul](https://www.elbisebul.com/) | E-commerce | -| [datarequests.org](https://www.datarequests.org/) | Search backend for the [company database](https://www.datarequests.org/company) that allows users to easily find the contact details for privacy-related requests | -| [furn.nl](https://furn.nl) | Dutch furniture comparison website | -| [FlyGRN](https://flygrn.com) | Flight Ticket Search Engine that ranks flights on carbon emissions and gives greener alternatives | -| [Have A Class](https://haveaclass.com/) | Find the perfect teacher online | -| [Jobsort](https://www.jobsort.com/) | Job search engine for developers, by developers (quicksort for tech jobs.) | -| [Bookology](https://play.google.com/store/apps/details?id=com.imihirpaldhikar.bookology) | "I am using Typesense for searching the the books listed on the platform. I switched from Algolia to Typesense because it is more convenient to only pay for the underlying infrastructure rather then paying for search queries. I will always use Typesense in my future projects." - @imihirpaldhikar -| [Puey Ungphakorn Institute for Economic Research](https://www.pier.or.th) | A research institute in Thailand | -| [Lawyaw](https://lawyaw.com) | Lawyaw provides easy to use document automation software that helps legal practices save time and avoid mistakes without sacrificing quality. *"Typesense is used as our search index and works great to search, sort and facet thousands of our Court forms each day. We look forward to working with Typesense for years to come as it continues to mature!" - @tpayne84* | -| [Job Ads Now](https://www.jobadsnow.com) | Job Ads Now is a jobs search engine focusing on the best candidate experience. Blazing fast search and filters by salary, location, bonus and more. You can also read the job highlights (TL;DR) for each job identified from the origina job post using AI | -| [OpenTacos](https://tacos.openbeta.io) | Free and open source rock climbing route wiki | | [Bikifi](https://bikifi.com/) | A free education platform that brings premium educational content to anyone, anywhere in Turkey | +| [Bookology](https://play.google.com/store/apps/details?id=com.imihirpaldhikar.bookology) | "I am using Typesense for searching the the books listed on the platform. I switched from Algolia to Typesense because it is more convenient to only pay for the underlying infrastructure rather then paying for search queries. I will always use Typesense in my future projects." - @imihirpaldhikar +| [Cults.](https://cults3d.com) | Find designs for 3D-printing. *We are very happy with our switch to Typesense, making it a breeze to setup and have pertinent results right from the start* | +| [datarequests.org](https://www.datarequests.org/) | Search backend for the [company database](https://www.datarequests.org/company) that allows users to easily find the contact details for privacy-related requests | +| [Dave & Adams Card World](https://www.dacardworld.com) | E-commerce platform for collectibles like sports cards, gaming cards, comics, or autographed memorabilia | +| [DiscMaster](http://discmaster.textfiles.com/search) | Search 94 million vintage computer files from archive.org | +| [Echidna Sewing](https://www.echidnasewing.com.au) | Echidna Sewing is one of Australia’s largest sewing machine dealers | +| [ElbiseBul](https://www.elbisebul.com/) | E-commerce | +| [FlyGRN](https://flygrn.com) | Flight Ticket Search Engine that ranks flights on carbon emissions and gives greener alternatives | +| [furn.nl](https://furn.nl) | Dutch furniture comparison website | +| [GlobalTill](https://www.globaltill.com) | Omnichannel Retail Management System | +| [Grafikart](https://www.grafikart.fr/) | Learning resources library | +| [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | +| [Have A Class](https://haveaclass.com/) | Find the perfect teacher online | +| [Iconduck](https://iconduck.com) | Site to search for open source icons | +| [Instatus](https://instatus.com) | System Status Pages Platform | +| [Job Ads Now](https://www.jobadsnow.com) | Job Ads Now is a jobs search engine focusing on the best candidate experience. Blazing fast search and filters by salary, location, bonus and more. You can also read the job highlights (TL;DR) for each job identified from the origina job post using AI | +| [Jobsort](https://www.jobsort.com/) | Job search engine for developers, by developers (quicksort for tech jobs.) | +| [Lawyaw](https://lawyaw.com) | Lawyaw provides easy to use document automation software that helps legal practices save time and avoid mistakes without sacrificing quality. *"Typesense is used as our search index and works great to search, sort and facet thousands of our Court forms each day. We look forward to working with Typesense for years to come as it continues to mature!" - @tpayne84* | +| [Magny SaaS search bar](https://magny.io) | Magny is a SaaS platform that helps implement command palettes, which significantly decreases the time users find anything in your app, leveraging the user experience and efficiency. | | [MyHearty](https://myhearty.my) | A one-stop charity website to fundraise, donate, volunteer and apply for aids. It comes with a full-featured search UI (instant search, geosearch) for campaigns, volunteer events and aids. | | [Neolace](https://www.neolace.com) | Knowledge graph platform (combines a wiki and a graph database) | +| [New York University Databrary](https://nyu.databrary.org/) | Video documentation library | +| [Oddle Eats](https://eats.oddle.me) | Food Delivery Service in Singapore | +| [OpenTacos](https://tacos.openbeta.io) | Free and open source rock climbing route wiki | +| [Orders Made Simple](https://ordersmadesimple.com) | A Stock ordering platform helping to connect hospitality and catering venues with their suppliers | +| [Otaku Square](https://www.otakusquare.com) | Online retailer for pop-culture (e.g. anime, games, movies) merchandise | +| [Plaza](https://www.useplaza.com) | Live-shopping platform | +| [Popcorn](https://onpopcorn.com) | Zoom meets Snapchat, async video chat app | | [Project Seldon](https://projectseldon.org) | A free and unbiased analysis platform for understanding societies and systems of government. | -| [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | +| [Puey Ungphakorn Institute for Economic Research](https://www.pier.or.th) | A research institute in Thailand | +| [Read This Twice](https://www.readthistwice.com/) | Book discovery platform uses typesense to power the book/people search | +| [Rushtix](https://rushtix.com) | Live Comedy Shows platform | +| [Service Foods](https://www.servicefoods.co.nz) | One of New Zealand's largest privately family owned and operated food service distribution businesses | | [Syracuse University](https://syracuse.edu) | A private research university in Syracuse, New York. [Visit our live typesense demo!](https://typesense-demo.dev3.digitalservices.syr.edu) | -| [Magny SaaS search bar](https://magny.io) | Magny is a SaaS platform that helps implement command palettes, which significantly decreases the time users find anything in your app, leveraging the user experience and efficiency. | -| [Cults.](https://cults3d.com) | Find designs for 3D-printing. *We are very happy with our switch to Typesense, making it a breeze to setup and have pertinent results right from the start* | +| [Trading Strategy](https://tradingstrategy.ai/blog/world-fastest-token-search) | Algorithmic trading protocol for decentralised markets | +| [Upnext](https://www.getupnext.com) | Save, organize and focus on your personal content library | +| [What's In My Jar](https://whatsinmyjar.com) | Skincare Research platform | ### Typesense Demos From d882df7c79b1a13e2608f933edc98de6b70be606 Mon Sep 17 00:00:00 2001 From: David Paulsson Date: Fri, 16 Jun 2023 13:47:29 +0200 Subject: [PATCH 09/22] Add hem.com to showcase --- SHOWCASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SHOWCASE.md b/SHOWCASE.md index 4bce23c9..48fa2a95 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -27,6 +27,7 @@ This is a selection of sites and apps using Typesense. | [Grafikart](https://www.grafikart.fr/) | Learning resources library | | [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | | [Have A Class](https://haveaclass.com/) | Find the perfect teacher online | +| [Hem.com](https://hem.com) | A premium furniture brand for the auction houses of tomorrow | | [Iconduck](https://iconduck.com) | Site to search for open source icons | | [Instatus](https://instatus.com) | System Status Pages Platform | | [Job Ads Now](https://www.jobadsnow.com) | Job Ads Now is a jobs search engine focusing on the best candidate experience. Blazing fast search and filters by salary, location, bonus and more. You can also read the job highlights (TL;DR) for each job identified from the origina job post using AI | From 4798b0595040b3138e6cfa775043f0ac81f34244 Mon Sep 17 00:00:00 2001 From: David Paulsson Date: Fri, 16 Jun 2023 13:52:43 +0200 Subject: [PATCH 10/22] Change "Hem.com" to "Hem" --- SHOWCASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SHOWCASE.md b/SHOWCASE.md index 48fa2a95..db79e14e 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -27,7 +27,7 @@ This is a selection of sites and apps using Typesense. | [Grafikart](https://www.grafikart.fr/) | Learning resources library | | [Granthappura](https://gpura.org/) | A free-licensed digitized artifacts archive related to Kerala from multiple languages. [Github Link](https://github.com/indic-archive/omeka-typesense-search) | | [Have A Class](https://haveaclass.com/) | Find the perfect teacher online | -| [Hem.com](https://hem.com) | A premium furniture brand for the auction houses of tomorrow | +| [Hem](https://hem.com) | A premium furniture brand for the auction houses of tomorrow | | [Iconduck](https://iconduck.com) | Site to search for open source icons | | [Instatus](https://instatus.com) | System Status Pages Platform | | [Job Ads Now](https://www.jobadsnow.com) | Job Ads Now is a jobs search engine focusing on the best candidate experience. Blazing fast search and filters by salary, location, bonus and more. You can also read the job highlights (TL;DR) for each job identified from the origina job post using AI | From f7edb599e92c94cf540f91240ee67c7e94445eb9 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Wed, 21 Jun 2023 15:59:10 -0500 Subject: [PATCH 11/22] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6f260900..d1e96d16 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Documentation | Roadmap | Slack Community | + Community Threads | Twitter | Office Hours

From f98c76e572575b3ed1303a9f5b3ca81616e11b8a Mon Sep 17 00:00:00 2001 From: Henri Dickson <90480431+alphatownsman@users.noreply.github.com> Date: Wed, 28 Jun 2023 21:59:36 -0400 Subject: [PATCH 12/22] Update SHOWCASE.md --- SHOWCASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SHOWCASE.md b/SHOWCASE.md index db79e14e..c2dba6cd 100644 --- a/SHOWCASE.md +++ b/SHOWCASE.md @@ -35,6 +35,7 @@ This is a selection of sites and apps using Typesense. | [Lawyaw](https://lawyaw.com) | Lawyaw provides easy to use document automation software that helps legal practices save time and avoid mistakes without sacrificing quality. *"Typesense is used as our search index and works great to search, sort and facet thousands of our Court forms each day. We look forward to working with Typesense for years to come as it continues to mature!" - @tpayne84* | | [Magny SaaS search bar](https://magny.io) | Magny is a SaaS platform that helps implement command palettes, which significantly decreases the time users find anything in your app, leveraging the user experience and efficiency. | | [MyHearty](https://myhearty.my) | A one-stop charity website to fundraise, donate, volunteer and apply for aids. It comes with a full-featured search UI (instant search, geosearch) for campaigns, volunteer events and aids. | +| [NeoDB](https://neodb.social/) | An open source project and free service to help users in Fediverse manage, share and discover collections, reviews and ratings for culture products, with a searchable catalog of over a million books, movies, music, podcasts, games and performances. | | [Neolace](https://www.neolace.com) | Knowledge graph platform (combines a wiki and a graph database) | | [New York University Databrary](https://nyu.databrary.org/) | Video documentation library | | [Oddle Eats](https://eats.oddle.me) | Food Delivery Service in Singapore | From 733fcd092b3a65d85a5bec6156ff4f025888bffe Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Tue, 15 Aug 2023 12:15:17 -0500 Subject: [PATCH 13/22] Update README for 0.25 --- README.md | 102 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 65 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index d1e96d16..45f80536 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,13 @@ - An E-Commerce Store Browsing experience: [ecommerce-store.typesense.org](https://ecommerce-store.typesense.org/) - GeoSearch / Browsing experience: [airbnb-geosearch.typesense.org](https://airbnb-geosearch.typesense.org/) - Search / Browse xkcd comics by topic: [xkcd-search.typesense.org](https://xkcd-search.typesense.org/) +- Semantic / Hybrid search on 300K HN comments: [hn-comments-search.typesense.org](https://hn-comments-search.typesense.org) πŸ—£οΈ πŸŽ₯ If you prefer watching videos: - Here's one where we introduce Typesense and show a walk-through: https://youtu.be/F4mB0x_B1AE?t=144 -- Here's our [roadmap](https://github.com/orgs/typesense/projects/1) call from Q1 2022: https://aviyel.com/events/297/typesense-community-call-q1-2022-roadmap-and-contributor-spotlight - Check out Typesense's recent mention during Google I/O Developer Keynote: https://youtu.be/qBkyU1TJKDg?t=2399 +- Here's one where one of our community members gives an overview of Typesense and shows you an end-to-end demo: https://www.youtube.com/watch?v=kwtHOkf7Jdg ## Quick Links @@ -70,12 +71,13 @@ - **Simple and Delightful:** Simple to set-up, integrate with, operate and scale. - **⚑ Blazing Fast:** Built in C++. Meticulously architected from the ground-up for low-latency (<50ms) instant searches. - **Tunable Ranking:** Easy to tailor your search results to perfection. -- **Sorting:** Sort results based on a particular field at query time (helpful for features like "Sort by Price (asc)"). +- **Sorting:** Dynamically sort results based on a particular field at query time (helpful for features like "Sort by Price (asc)"). - **Faceting & Filtering:** Drill down and refine results. - **Grouping & Distinct:** Group similar results together to show more variety. - **Federated Search:** Search across multiple collections (indices) in a single HTTP request. -- **Geo Search:** Search and sort by results around a geographic location. -- **Vector search:** support for both exact & HNSW-based approximate vector searching. +- **Geo Search:** Search and sort by results around a latitude/longitude or within a bounding box. +- **Vector Search:** Index embeddings from your machine learning models in Typesense and do a nearest-neighbor search. Can be used to build similarity search, semantic search, visual search, recommendations, etc. +- **Semantic / Hybrid Search:** Automatically generate embeddings from within Typesense using built-in models like S-BERT, E-5, etc or use OpenAI, PaLM API, etc, for both queries and indexed data. This allows you to send JSON data into Typesense and build an out-of-the-box semantic search + keyword search experience. - **Scoped API Keys:** Generate API keys that only allow access to certain records, for multi-tenant applications. - **Synonyms:** Define words as equivalents of each other, so searching for a word will also return results for the synonyms defined. - **Curation & Merchandizing:** Boost particular records to a fixed position in the search results, to feature them. @@ -83,7 +85,7 @@ - **Seamless Version Upgrades:** As new versions of Typesense come out, upgrading is as simple as swapping out the binary and restarting Typesense. - **No Runtime Dependencies:** Typesense is a single binary that you can run locally or in production with a single command. -**Don't see a feature on this list?** Search our issue tracker if someone has already requested it and add a comment to it explaining your use-case, or open a new issue if not. We prioritize our roadmap based on user feedback, so we'd love to hear from you. +**Don't see a feature on this list?** Search our issue tracker if someone has already requested it and add a comment to it explaining your use-case, or open a new issue if not. We prioritize our roadmap based on user feedback, so we'd love to hear from you. ## Roadmap @@ -107,8 +109,11 @@ We'd love to benchmark with larger datasets, if we can find large ones in the pu ## Who's using this? -Typesense is used by a range of users across different industries. We've only recently started documenting who's using it in our [Showcase](SHOWCASE.md). +Typesense is used by a range of users across different domains and verticals. +On Typesense Cloud we serve more than **1 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. + +We've recently started documenting who's using it in our [Showcase](SHOWCASE.md). If you'd like to be included in the list, please feel free to edit [SHOWCASE.md](SHOWCASE.md) and send us a PR. You'll also see a list of user logos on the [Typesense Cloud](https://cloud.typesense.org) home page. @@ -116,7 +121,7 @@ You'll also see a list of user logos on the [Typesense Cloud](https://cloud.type ## Install **Option 1:** You can download the [binary packages](https://typesense.org/downloads) that we publish for -Linux (x86-64) and Mac. +Linux (x86_64 & arm64) and Mac (x86_64). **Option 2:** You can also run Typesense from our [official Docker image](https://hub.docker.com/r/typesense/typesense). @@ -131,7 +136,7 @@ Here's a quick example showcasing how you can create a collection, index a docum Let's begin by starting the Typesense server via Docker: ``` -docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.1 --data-dir /data --api-key=Hu52dwsas2AdxdE +docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.25.0 --data-dir /data --api-key=Hu52dwsas2AdxdE ``` We have [API Clients](#api-clients) in a couple of languages, but let's use the Python client for this example. @@ -212,29 +217,60 @@ If you notice any issues with the documentation or walk-through, please let us k While you can definitely use CURL to interact with Typesense Server directly, we offer official API clients to simplify using Typesense from your language of choice. The API Clients come built-in with a smart retry strategy to ensure that API calls made via them are resilient, especially in an HA setup. -- [typesense-js](https://github.com/typesense/typesense-js) -- [typesense-php](https://github.com/typesense/typesense-php) -- [typesense-python](https://github.com/typesense/typesense-python) -- [typesense-ruby](https://github.com/typesense/typesense-ruby) +- [JavaScript](https://github.com/typesense/typesense-js) +- [PHP](https://github.com/typesense/typesense-php) +- [Python](https://github.com/typesense/typesense-python) +- [Ruby](https://github.com/typesense/typesense-ruby) If we don't offer an API client in your language, you can still use any popular HTTP client library to access Typesense's APIs directly. Here are some community-contributed clients and integrations: -- [API client for Go](https://github.com/typesense/typesense-go) -- [API client for Dart](https://github.com/typesense/typesense-dart) -- [API client for C#](https://github.com/DAXGRID/typesense-dotnet) -- [Laravel Scout driver](https://github.com/devloopsnet/laravel-scout-typesense-engine) -- [Symfony integration](https://github.com/acseo/TypesenseBundle) +- [Go](https://github.com/typesense/typesense-go) +- [.Net](https://github.com/DAXGRID/typesense-dotnet) +- [Java](https://github.com/typesense/typesense-java) +- [Rust](https://github.com/typesense/typesense-rust) +- [Dart](https://github.com/typesense/typesense-dart) +- [Perl](https://github.com/Ovid/Search-Typesense) +- [Swift](https://github.com/typesense/typesense-swift) +- [Clojure](https://github.com/runeanielsen/typesense-clj) +- [python orm client](https://github.com/RedSnail/typesense_orm) +- [PHP SEAL Adapter](https://github.com/schranz-search/seal-typesense-adapter) +- [Elixir](https://github.com/jaeyson/ex_typesense) -We welcome community contributions to add more official client libraries and integrations. Please reach out to us at contact@typsense.org or open an issue on Github to collaborate with us on the architecture. πŸ™ +We welcome community contributions to add more official client libraries and integrations. Please reach out to us at contact@typsense.org or open an issue on GitHub to collaborate with us on the architecture. πŸ™ + +### Framework Integrations + +We also have the following framework integrations: + +- [Laravel](https://github.com/typesense/laravel-scout-typesense-engine) +- [Firebase](https://github.com/typesense/firestore-typesense-search) +- [Gatsby](https://www.gatsbyjs.com/plugins/gatsby-plugin-typesense/) +- [WordPress](https://wordpress.org/plugins/search-with-typesense/?ref=typesense) +- [WooCommerce](https://www.codemanas.com/downloads/typesense-search-for-woocommerce/?ref=typesense) +- [Symfony](https://github.com/acseo/TypesenseBundle) +- [InstantSearch](https://github.com/typesense/typesense-instantsearch-adapter) +- [DocSearch](https://typesense.org/docs/guide/docsearch.html) +- [Docusaurus](https://github.com/typesense/docusaurus-theme-search-typesense) +- [ToolJet](https://tooljet.com/?ref=typesense) +- [Plone CMS](https://pypi.org/project/zopyx.typesense/) +- [Craft CMS](https://plugins.craftcms.com/typesense) +- [SEAL](https://github.com/schranz-search/schranz-search) provides integrations of Typesense in Laravel, Symfony, Spiral, Yii and Laminas Mezzio PHP Framework + +### Postman Collection + +We have a community-maintained Postman Collection here: [https://github.com/typesense/postman](https://github.com/typesense/postman). + +[Postman](https://www.postman.com/downloads/) is an app that let's you perform HTTP requests by pointing and clicking, instead of having to type them out in the terminal. +The Postman Collection above gives you template requests that you can import into Postman, to quickly make API calls to Typesense. ## Search UI Components You can use our [InstantSearch.js adapter](https://github.com/typesense/typesense-instantsearch-adapter) to quickly build powerful search experiences, complete with filtering, sorting, pagination and more. -Here's how: [https://typesense.org/docs/0.24.1/guide/#search-ui](https://typesense.org/docs/0.24.1/guide/#search-ui) +Here's how: [https://typesense.org/docs/guide/search-ui-components.html](https://typesense.org/docs/guide/search-ui-components.html) ## FAQ @@ -311,13 +347,13 @@ If you have specifics that prevent you from using Typesense due to a licensing i ## Support -πŸ‘‹ 🌐 New: If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). +πŸ‘‹ 🌐 If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). We also do virtual office hours every Friday. Reserve a time slot [here](https://calendly.com/jason-typesense/typesense-office-hours). -If you run into any problems or issues, please create a Github issue and we'll try our best to help. +If you run into any problems or issues, please create a GitHub issue and we'll try our best to help. -We strive to provide good support through our issue trackers on Github. However, if you'd like to receive private & prioritized support with: +We strive to provide good support through our issue trackers on GitHub. However, if you'd like to receive private & prioritized support with: - Guaranteed SLAs - Phone / video calls to discuss your specific use case and get recommendations on best practices @@ -333,23 +369,15 @@ We are a lean team on a mission to democratize search and we'll take all the hel ## Getting Latest Updates -If you'd like to get updates when we release new versions, click on the "Watch" button on the top and select "Releases only". Github will then send you notifications along with a changelog with each new release. +If you'd like to get updates when we release new versions, click on the "Watch" button on the top and select "Releases only". GitHub will then send you notifications along with a changelog with each new release. We also post updates to our Twitter account about releases and additional topics related to Typesense. Follow us here: [@typesense](https://twitter.com/typesense). -πŸ‘‹ 🌐 New: We'll also post updates on our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). +πŸ‘‹ 🌐 We'll also post updates on our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). ## Build from source -**Building with Docker** - -The docker build script takes care of all required dependencies, so it's the easiest way to build Typesense: - -``` -TYPESENSE_VERSION=nightly ./docker-build.sh --build-deploy-image --create-binary [--clean] [--depclean] -``` - -**Building on your machine** +We use [Bazel](https://bazel.build) to build Typesense. Typesense requires the following dependencies: @@ -359,11 +387,11 @@ Typesense requires the following dependencies: * OpenSSL (>=1.0.2) * curl * ICU -* brpc -* braft -``` -./build.sh --create-binary [--clean] [--depclean] +Once you've installed them, run the following from the root of the repo: + +```shell +bazel build //:typesense-server ``` The first build will take some time since other third-party libraries are pulled and built as part of the build process. From 5f563184c1be8df7f66a88982c39a8e1b5541774 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Tue, 15 Aug 2023 12:24:23 -0500 Subject: [PATCH 14/22] Update README for 0.25.0 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 45f80536..99adc8b2 100644 --- a/README.md +++ b/README.md @@ -388,6 +388,8 @@ Typesense requires the following dependencies: * curl * ICU +Please refer to the [CI build steps](.github/workflows/tests.yml) for the latest set of dependencies. + Once you've installed them, run the following from the root of the repo: ```shell From 2e1d80014d6beeee66eec4d8712f39fb64ace7bc Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 31 Aug 2023 12:01:51 -0500 Subject: [PATCH 15/22] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99adc8b2..fd213ced 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@

- +
+

Website | @@ -111,7 +112,7 @@ We'd love to benchmark with larger datasets, if we can find large ones in the pu Typesense is used by a range of users across different domains and verticals. -On Typesense Cloud we serve more than **1 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. +On Typesense Cloud we serve more than **1.5 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. We've recently started documenting who's using it in our [Showcase](SHOWCASE.md). If you'd like to be included in the list, please feel free to edit [SHOWCASE.md](SHOWCASE.md) and send us a PR. From 43f4d65412edad4a86f3d2b15a2141d0ea133e99 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Mon, 11 Sep 2023 10:33:56 -0500 Subject: [PATCH 16/22] Update README for 0.25.1 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd213ced..08fcfd7e 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ Here's a quick example showcasing how you can create a collection, index a docum Let's begin by starting the Typesense server via Docker: ``` -docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.25.0 --data-dir /data --api-key=Hu52dwsas2AdxdE +docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.25.1 --data-dir /data --api-key=Hu52dwsas2AdxdE ``` We have [API Clients](#api-clients) in a couple of languages, but let's use the Python client for this example. From e4b360d0ee80d9002a36ec4fb3fe6fa149ded596 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Tue, 24 Oct 2023 15:23:52 -0500 Subject: [PATCH 17/22] Fix Slack community link --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 08fcfd7e..83d75673 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Website | Documentation | Roadmap | - Slack Community | + Slack Community | Community Threads | Twitter | Office Hours @@ -348,7 +348,7 @@ If you have specifics that prevent you from using Typesense due to a licensing i ## Support -πŸ‘‹ 🌐 If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). +πŸ‘‹ 🌐 If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-25mb3r14m-60o24PIIkDt~a6x7mk1XDQ). We also do virtual office hours every Friday. Reserve a time slot [here](https://calendly.com/jason-typesense/typesense-office-hours). @@ -374,7 +374,7 @@ If you'd like to get updates when we release new versions, click on the "Watch" We also post updates to our Twitter account about releases and additional topics related to Typesense. Follow us here: [@typesense](https://twitter.com/typesense). -πŸ‘‹ 🌐 We'll also post updates on our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg). +πŸ‘‹ 🌐 We'll also post updates on our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-25mb3r14m-60o24PIIkDt~a6x7mk1XDQ). ## Build from source From 9f56a25ad66d74f8d187ff9e3008d6c877a9d225 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Wed, 1 Nov 2023 13:12:09 -0500 Subject: [PATCH 18/22] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83d75673..45e77c06 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@
- +

Website | @@ -112,7 +112,7 @@ We'd love to benchmark with larger datasets, if we can find large ones in the pu Typesense is used by a range of users across different domains and verticals. -On Typesense Cloud we serve more than **1.5 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. +On Typesense Cloud we serve more than **1.7 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. We've recently started documenting who's using it in our [Showcase](SHOWCASE.md). If you'd like to be included in the list, please feel free to edit [SHOWCASE.md](SHOWCASE.md) and send us a PR. From 09568167178ecb7f337eaa247e80892d58fc3b9e Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 30 Nov 2023 23:40:12 -0600 Subject: [PATCH 19/22] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45e77c06..3fbb8308 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@
- +

Website | @@ -112,7 +112,7 @@ We'd love to benchmark with larger datasets, if we can find large ones in the pu Typesense is used by a range of users across different domains and verticals. -On Typesense Cloud we serve more than **1.7 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. +On Typesense Cloud we serve more than **1.9 BILLION** searches per month. Typesense's Docker images have been downloaded over 7M times. We've recently started documenting who's using it in our [Showcase](SHOWCASE.md). If you'd like to be included in the list, please feel free to edit [SHOWCASE.md](SHOWCASE.md) and send us a PR. From eb9ef31aaadb8217e9aefdd393917e176aa84a81 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Wed, 22 Nov 2023 17:28:15 -0600 Subject: [PATCH 20/22] Fix bazel cache downloading in CI --- .github/workflows/tests.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 649da61a..280e69e9 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -38,15 +38,17 @@ jobs: uses: bazelbuild/setup-bazelisk@v2 - name: Download bazel cache - uses: dawidd6/action-download-artifact@v2 + uses: jasonbosco/action-download-artifact@709b71d3729e8980f52a5a2a9ec04261060945c1 with: name: bazel-cache search_artifacts: true workflow_conclusion: "" if_no_artifact_found: warn + skip_unpack: true - name: Uncompress bazel cache run: | + unzip bazel-cache.zip mkdir -p ~/.cache/bazel tar_file="bazel-cache.tar.gz" && \ [ -f "$tar_file" ] && \ From c2fcbd0d945216ed25fa266bc3725f165a2349df Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 23 Nov 2023 17:09:51 -0600 Subject: [PATCH 21/22] Pull build cache from main --- .github/workflows/tests.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 280e69e9..5378e09c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -45,6 +45,7 @@ jobs: workflow_conclusion: "" if_no_artifact_found: warn skip_unpack: true + branch: main - name: Uncompress bazel cache run: | From fe259266016230e0a3f48cc1413a56e62dfd7f97 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Tue, 12 Dec 2023 21:28:47 -0600 Subject: [PATCH 22/22] Use per-branch bazel cache --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 5378e09c..5ad2d8c3 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -45,7 +45,7 @@ jobs: workflow_conclusion: "" if_no_artifact_found: warn skip_unpack: true - branch: main + branch: ${{ github.head_ref || github.ref_name }} - name: Uncompress bazel cache run: |