Fuzzy Search Example

An example of how to implement client-side fuzzy-search.

Built With

• 
• 
• 

Getting Started

1. Download starter and install dependencies

Clone this repository:

git clone [email protected]:BCIT-DDC/fuzzy-search-example.git

Install npm dependencies:

cd fuzzy-search-example
npm install

2. Start the Next.js Development Server

npm run dev

The application should now be running on http://localhost:3000, as shown below.

Usage

This implementation uses a fuzzy search library called, Fuse.js. Fuse is meant for light-weight client-side querying of small to moderately large data sets. If you require dedicated backends for handling search, Elastic Search or Algolia may be better fit.

Roadmap

• Implement in Vue.js
• Add speech API polyfills for other browsers

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you would like to contribute, please have a look at our contributing guidelines.

Contributors

This project exists thanks to all the people who contribute.

License

MIT © BCIT-DDC

Acknowledgments

• Fuse.js
• Heroicons
• Headless UI