Skip to content

miko-engr/checkpoint1-inverted-index

Repository files navigation

Build Status Code Climate Test Coverage

Inverted-index

This Application is an implementation of Elastic Search indexing algorithm which is designed to allow for fas full-text search. An Inverted-index consists of a list of all the unique words that appear in any document, and for each word, a list of the documents in which it appears.

Features

  • Upload of JSON file in the format below
[
    {
        "title": "This is a sample title",
        "text": "And this is a sample text"
    }
]
  • Indexing of uploaded file
  • Searching of each indexed file

Usage

This can be accessed here.

It can be used locally with the following steps

  • Clone this repository git clone https://github.com/andela-aatanda/checkpoint1-inverted-index.git
  • Move into the repository directory cd checkpoint1-inverted-index
  • Run npm install to install all dependencies (Node must be installed on your local machine already)

Dependencies

  1. connect
  2. gulp
  3. gulp-connect
  4. serve-static

npm install

  • Start the application with npm start

Limitations

  • Only files with .json extension can be indexed
  • Search is limited to one file at a time

More information

About

This project implements Elastic inverted index search

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published