A library of widgets and helpers to build instant-search applications on Android.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.bundle chore(bundle): use vendor, update Gemfile.lock May 24, 2018
.github chore: Add PR & issues template (#107) Dec 14, 2018
core nit: Add quotes around error's attribute [ci skip] Nov 27, 2018
docgen docs: Mention androidx artifacts Nov 28, 2018
fastlane chore(fastlane): Update to 2.108.0 Nov 22, 2018
gradle/wrapper chore: Upgrade gradle to 4.10 Nov 22, 2018
scripts fix(release): Force push androidX Release Nov 27, 2018
tools tools: add setup-release script Apr 13, 2018
ui chore: Remove obsolete TODO Nov 28, 2018
.gitignore chore: Gitignore docgen local history Nov 22, 2018
.netlify chore: Add netlify identifier Jan 24, 2017
CHANGELOG.md chore(release): Version 1.14.2 [ci skip] Nov 28, 2018
CONTRIBUTING.md docs: Adapt contributing dev instructions Nov 22, 2018
Gemfile chore(Gemfile): Mention httparty for bitrise May 18, 2018
Gemfile.lock chore(fastlane): Update to 2.108.0 Nov 22, 2018
ISSUE_TEMPLATE.md docs: Add Issue Template May 15, 2018
LICENSE.md Project: Add MIT License Oct 5, 2016
README.md docs: Mention androidx artifacts Nov 28, 2018
build.gradle fix: Downgrade gradle to last stable Nov 26, 2018
common.gradle feat(gradle): multi-module release, split logic into ext/libraries/re… Nov 22, 2018
gradle.properties refactor: Inline gradle vars, update robolectric to 4.0 Nov 22, 2018
gradlew chore: Update API/Gradle, add consumerProguardFile (#8) Dec 13, 2016
gradlew.bat chore: Update API/Gradle, add consumerProguardFile (#8) Dec 13, 2016
javadoc.options feat(gradle): multi-module release, split logic into ext/libraries/re… Nov 22, 2018
libraries.gradle feat(gradle): multi-module release, split logic into ext/libraries/re… Nov 22, 2018
properties.gradle chore(release): Version 1.14.2 [ci skip] Nov 28, 2018
release.gradle fix: Downgrade gradle to last stable Nov 26, 2018
release.sh feat(release): Release AndroidX artifacts too Nov 27, 2018
run_tests.sh Tests: add scripts for handling env variables, test pending requests Aug 1, 2016
settings.gradle refactor: Split core and ui Nov 22, 2018
setup_tests.sh feat(run_tests.sh): Avoid unnecessary copy Dec 16, 2016
standalone.gradle refactor: ext -> properties.gradle Nov 22, 2018
teardown_tests.sh feat(run_tests.sh): Avoid unnecessary copy Dec 16, 2016

README.md

InstantSearch Android

Build Status

InstantSearch family: InstantSearch Android | InstantSearch iOS | React InstantSearch | InstantSearch.js | Angular InstantSearch | Vue InstantSearch.

InstantSearch Android is a library providing widgets and helpers to help you build the best instant-search experience on Android with Algolia. It is built on top of Algolia's Android API Client to provide you a high-level solution to quickly build various search interfaces.

Demo

You can see InstantSearch Android in action in our Examples repository, in which we published two example apps built with InstantSearch:

Media app E-commerce app
animated screenshot of media app animated screenshot of e-commerce app

Usage

You can add InstantSearch to your Android application by adding one of the following to your build.gradle's dependencies. Note that until a Bug in Jetifier is resolved, if you use AndroidX you should target our instantsearch-androidx artifacts.

implementation 'com.algolia:instantsearch-android:1.14.2'
// OR, if your application uses AndroidX
implementation 'com.algolia:instantsearch-androidx:1.14.2'

To use InstantSearch's Core without the UI components and helpers, you should use this instead:

implementation 'com.algolia:instantsearch-android-core:1.14.2'
// OR, if your application uses AndroidX
implementation 'com.algolia:instantsearch-androidx-core:1.14.2'

See the dedicated documentation website.

You can start with the Getting Started Guide.

Contributing

From reporting bugs or missing functionality to fixing a typo or proposing an improvement, all contributions are welcome! Read the Contributing Guide to setup your development environment.

License

InstantSearch Android is MIT licensed.