Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 1.54 KB
Raw

React InstantSearch

Requirements

To run this project, you will need:

Development

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

yarn
yarn start

Go to http://localhost:3000 for the documentation website. Go to http://localhost:6006 for Storybook.

The applications won't reload on code change. To enable the watch mode, run the following command in another tab.

yarn watch

Code

The code for React InstantSearch is located in packages.

Test

We have unit tests written with Jest:

Single run:

yarn test

Watch mode:

yarn test:watch

Lint

yarn lint

Files are automatically formatted with Prettier.

Release

yarn release

Beta release

yarn release --beta

Append -beta.x where x is a number to the version for beta, so 4.0.0-beta.2 for example.

Update docs

yarn docs:deploy-production

Deploy a preview of docs

yarn docs:deploy-preview

This uses netlify.