Giter VIP home page Giter VIP logo

lunr.js's Introduction

Lunr

A bit like Solr, but much smaller and not as bright.

Example

Go to http://olivernn.github.com/lunr.js/example.html. There are adaptors already for JS-Model & Backbone. You can also see an example of the search working in the now traditional 'Todo' demo app for backbone

Description

A very simple, client side, full-text search engine for JSON documents. Can index and search large amounts of data quickly and efficiently.

This is a young library, the API and implementation is open to change. Any feedback is welcome and appreciated, issues should be raised for any bugs or feature requests.

Why

Search is something usually handled by a server, by being able to offer some kind of full text search on the client we can make sure that the user can search, even when they are not connected to the internet. It also means one less service to keep running on your server.

Installation

Include the lunr.js file in your page.

Todo

Currently this is in the early stages of development, however I have the following plans:

  • More efficient storage of the search index.
  • Make the search index persistable.
  • Allow for the use of other language based algorithms, e.g. metaphoning.
  • Allow for the use of other languages, not everyone speaks English!
  • Build a server side implementation with Node.js
  • Add adaptors for other popular JavaScript frameworks, e.g. Ember & Spine.

lunr.js's People

Contributors

olivernn avatar benpickles avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.