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

react-instantsearch is a set of widgets and connectors to add instant-search experiences in your React application, using Algolia search engine.

Documentation: https://community.algolia.com/instantsearch.js/react/.

Table of Contents

• Project structure
• Development
• Test
• Lint
• Release
• Update docs

Development

We use the documentation website as the main way to develop react-instantsearch.

yarn
npm start

Go to http://localhost:3000.

Test

We have unit tests for all packages/:

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

npm run dev # unit tests watch mode, no lint

Lint

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

Release

npm run release

Update docs

npm run docs:update

What about instantsearch.js?

instantsearch.js is 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 the near future this current repository will hold any instant-search related project:

• instantsearch-core
• instantsearch.js v2 (based on react-instantsearch)
• instantsearch-vue
• …

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.