Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 1.25 KB

Contributing

You can do code and documentation contributions.

Documentation

To modify the documentation, clone this repo, switch to the gitbook branch then update the markdown files.

Code

Setup

You need latest LTS NodeJS (^8.6.0) use nvm and yarn as package manager.

  • > git clone https://github.com/algolia/angular-instantsearch.git
  • > npm i -g yarn
  • > cd angular-instantsearch && yarn

Run

You can watch & reload library using > yarn dev and then open http://localhost:8080 to access stories of Angular InstantSearch components rendered into dev-novel.

There is also an e-commerce example consuming the builded library and compliant to AOT (compiles your app at build time) compiler. It must be run to test the library in production before any PRs.

You can use > yarn examples:ecommerce and open http://localhost:4200 to access the e-commerce example.

Test

Tests are ran with jest and jest-preset-angular.

  • > yarn test -> run all tests
  • > yarn test:watch -> run tests and watch for changes