Looking for instantsearch.js instead? Go to the develop branch.

InstantSearch

This is the main README of the InstantSearch project.

Currently we support React and plain JavaScript (or Vanilla) via:

• ⚛ React and React Native ➡️ React InstantSearch
• 🍦 Vanilla ➡️ InstantSearch.js

This current branch (v2) holds the code for React InstantSearch, see project status for more information on project structure.

Development

We use the documentation website as the main way to develop React InstantSearch.

yarn boot
yarn start

Go to http://localhost:3000.

Test

We have unit tests for all packages/:

yarn test # one shot run, also lint and tries to build the documentation

yarn dev # unit tests watch mode, no lint

Lint

yarn lint # only changed files in dev, all files in CI
yarn lint:fix

Release

npm run release

This cannot yet be moved to yarn release so please use npm run release.

Update docs

yarn docs:deploy-production

Deploy a preview of docs

yarn docs:deploy-preview

This uses netlify.

Upgrade deps

yarn upgrade-deps

See next release changelog

yarn changelog

Project status

InstantSearch.js was our first instant-search related project. We still support the current version (v1.x.x) of it. And you can still count on contributors to fix bugs.

In a near future this current repository will hold any instant-search related project:

• InstantSearch Core
• InstantSearch.js v2 (based on React InstantSearch)
• InstantSearch Vue
• InstantSearch Angular
• …

While we are in transition mode, the v2 branch is the main development branch for any of the upcoming projects.

The develop branch will soon be renamed v1 and v2 will be the new develop as soon as we have instantsearch.js v2.