mdeora / instantsearch

⚡️ Libraries for building performant and instant search experiences with Algolia. Compatible with JavaScript, TypeScript, React and Vue.

InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React, Vue and Angular with Algolia.

---

InstantSearch is a JavaScript library that lets you create an instant-search result experience using Algolia’s search API.

There are multiple wrappers for popular frameworks, such as React InstantSearch, Vue InstantSearch, and Angular InstantSearch.

It is part of the InstantSearch family which is designed for different platforms:

InstantSearch | Angular InstantSearch | InstantSearch Android | InstantSearch iOS

Table of contents

• Packages
• Contributing
• License

Packages

Package	Version	Description
algoliasearch-helper		Helper for implementing advanced search features with Algolia
create-instantsearch-app		Command-line utility to quickly bootstrap a project with InstantSearch
instantsearch.css		Default CSS themes for InstantSearch
instantsearch.js		InstantSearch.js
react-instantsearch		React InstantSearch bundled library
react-instantsearch-core		Runtime-independent React InstantSearch version
vue-instantsearch		Vue InstantSearch

Contributing

We welcome all contributors, from casual to regular 💙

• Bug report. Is something not working as expected? Send a bug report.
• Feature request. Would you like to add something to the library? Send a feature request.
• Documentation. Did you find a typo in the doc? Open an issue and we'll take care of it.
• Development. If you don't know where to start, you can check the open issues that are tagged easy, the bugs or chores.

To start contributing to code, you need to:

1. Fork the project
2. Clone the repository
3. Install the dependencies: yarn
4. Pick a package to work on and cd into it (e.g. cd packages/react-instantsearch)

Please read our contribution process to learn more.

License

InstantSearch is MIT licensed.