https://github.com/chadokruse/algolia-materialize-jekyll

A template for creating simple web apps using Algolia, Materailize, and Jekyll.
https://github.com/chadokruse/algolia-materialize-jekyll

algolia algolia-instantsearch jekyll materialize

Last synced: 3 months ago
JSON representation

A template for creating simple web apps using Algolia, Materailize, and Jekyll.

• Host: GitHub
• URL: https://github.com/chadokruse/algolia-materialize-jekyll
• Owner: chadokruse
• License: mit
• Created: 2017-10-15T22:14:49.000Z (about 7 years ago)
• Default Branch: gh-pages
• Last Pushed: 2018-11-17T20:13:57.000Z (about 6 years ago)
• Last Synced: 2024-05-01T23:31:34.309Z (8 months ago)
• Topics: algolia, algolia-instantsearch, jekyll, materialize
• Language: JavaScript
• Homepage: https://www.chadkruse.com/algolia-materialize-jekyll/
• Size: 1.87 MB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## Algolia Instantsearch Materialize Jekyll

A Jekyll template for quickly getting up and running with [Algolia](https://www.algolia.com/) and [Materialize](http://materializecss.com/).

Leverages Algolia's Instantsearch library ([docs](https://community.algolia.com/instantsearch.js/)), which makes it drop dead simple to create good search UX.

### Data

An example dataset is provided for convenience. Please upload the dataset to your own Algolia project and update the Algolia credentials in [`search.js`](https://github.com/chadokruse/algolia-materialize-jekyll/blob/64371c9300c180de9a416423286b9bd071e05dad/assets/js/search.js#L15).

### Limitations

I use the template primarily for prototyping purposes, thus robust browser support is not a concern. Due to the use of [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals), [IE 11 support](https://caniuse.com/#feat=template-literals) will require minor modification to [`search.js`](https://github.com/chadokruse/algolia-materialize-jekyll/blob/64371c9300c180de9a416423286b9bd071e05dad/assets/js/search.js#L24).

### Bugs & Roadmap

There are a few known bugs and a relatively short wish list (primarily mobile related), all of which are listed in [this Waffle board](https://waffle.io/chadokruse/algolia-materialize-jekyll).

### Screenshot & Demo

[Live demo](https://www.chadkruse.com/algolia-materialize-jekyll/)

![Screenshot](assets/img/algolia-materialize-jekyll.png?raw=true "Screenshot")

### License

Both Materialize and Algolia Instantsearch are licensed under the terms of the MIT license.

This project is also licensed under the terms of the MIT license.