/checkpoint1-inverted-index

A search app like elasticsearch

Primary LanguageJavaScript

Inverted-index

Coverage Status Code Climate

In computer science, an inverted index (also referred to as postings file or inverted file) is an index data structure storing a mapping from content, such as words or numbers, to its locations in a database file, or in a document or a set of documents.

Common Uses: Inverted indices have found use in the design of Search Engines, Sequence Assembly of DNA and Library, Mainframe and Database management.

Features of the application

  • Single or multiple upload of valid a json file
  • Create an index to the words in the file and their location
  • Delete created index
  • Search single or all indexed files for their location and content

How to Install

  1. Clone the repository git clone https://github.com/xmile1/checkpoint1-inverted-index.git

  2. Move into the repository directory cd checkpoint1-inverted-index

  3. Run npm install to install all the dependencies. The application is build on Nodejs npm install

    Dependencies

    • gulp
    • coveralls (test coverage reporting)
    • karma (test)
    • eslint (code style)
    • file-input (file Upload Preview)

  4. Start the application by executing the command npm start

  5. You can also click on the link https://inverted-index-checkp1.herokuapp.com/ to use the app on Heroku

How to Run Test

  • To run tests, you can run the command below npm test

How to Use

  1. Upload valid json files you need to search from in the format below
  2. create index of the uploaded file
  3. enter your search term to search for a word

#Limitations

  1. This app does not use a database hence uploads are lost per session.