https://github.com/reyesr/fullproof

javascript fulltext search engine library
https://github.com/reyesr/fullproof

Last synced: 3 months ago
JSON representation

javascript fulltext search engine library

• Host: GitHub
• URL: https://github.com/reyesr/fullproof
• Owner: reyesr
• License: apache-2.0
• Created: 2012-08-26T10:52:39.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-03-11T18:41:47.000Z (over 11 years ago)
• Last Synced: 2024-05-23T05:33:00.289Z (6 months ago)
• Language: JavaScript
• Homepage: http://reyesr.github.com/fullproof/
• Size: 1.84 MB
• Stars: 666
• Watchers: 44
• Forks: 46
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
FullProof

=========

A javascript-based fulltext search engine library.

Fullproof provides a full stack of components for managing a search engine in javascript.

Its main features are:

* Boolean and Scoring search engines available, depending on the kind of search your application needs

* Automatic HTML5 storage detection, and graceful degradation, with a configurable constraint-based capabilities system. Currently manages WebSQL, IndexedDB and Memory data storage.

* Full unicode support and normalization, diacritical marks removal, stemming and phonetical algorithms (currently available for english and french)

* Configurable and very easely extensible parsing and token normalization system

* Easy to integrate, zero external dependency, ~100k minified

Note that fullproof is NOT a document management system, it does only one thing: provide fulltext search to your application, it does not aim at storing documents or data.

##Licence

Fullproof is released under the terms of the Apache License, version 2.0, january 2004

##Useful Links

* The main web site is located at http://reyesr.github.com/fullproof/

* The source code is hosted at GitHub's: https://github.com/reyesr/fullproof

* Information can be found in the wiki: https://github.com/reyesr/fullproof/wiki

* Bug reports and evolution requests can be reported at: https://github.com/reyesr/fullproof/issues

##Building

The `tools` directory contains `build-all.sh` that can be used to create a

convenient `fullproof-all.js` file containing everything you might need to get

going on a Fullproof project. Note that in a production system you may want to

just include specific Javascript files, not everything (see the examples).

To build `fullproof-all.js`:

    $ cd tools

    $ ./build-all.sh

If you have the Google closure compiler (see

https://developers.google.com/closure/compiler/) you might prefer to run

    $ cd tools

    $ CLOSURE_COMPILER_JAR=/path/to/your/compiler.jar ./build-all.sh

All output from the build process will appear in the top-level `build`

directory.  In particular, see `build/js/fullproof-all.js`.

##Contribute !

You can help improve fullproof and fulltext research by creating new algorithms:

- Tokenizers for specific formats and/or languages (html, pdf, epub, etc, or any language where tokenization have special rules)

- New normalizers: Normalizers help improve drastically the quality of the search. The current token normalizers

  for english (porter stemmer, metaphone, etc) are rather naive and can surely be enhanced. If you are a native

  speaker for a non-english language, you can also help by providing normalizers adapted to your language.

- More stores. Think you can optimize the current stores implementation ? Or create a new store ? Go ahead!

You can fork fullproof at https://github.com/reyesr/fullproof