Skip to content

About

Project files for the 'Inverted Index' Javascript checkpoint

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Build Status Coverage Status Code Climate

inverted-index

Introduction

An application that takes in a JSON array of text objects and creates an index from the array allowing users to search for words contained in the array.

Key Features

  • Upload of JSON file in below format.
[
    {"title": "Heroku",
    "text":"You will be asked to enter your Heroku credentials the first time you run a command; after the first time, your email address and an API token will be saved"
    },
    {"title": "Coveralls",
    "text": "See the latest code-coverage statistics on all of your repositories including the total percentages covered and the lines covered."
    }
]
  • Creates Index of all documents with title and text keys in uploaded file.
  • Searching of indexed files.

How to use the APP

For Web use

Available via heroku hosted platform on : https://inverted-index-otoloye.herokuapp.com

Local Machine

git clone https://github.com/andela-ooyeniran/inverted-index.git

Change directory into inverted-index and follow the steps below.
  • Install all the dependencies (you must have installed Nodejs):
npm install
  • Run Tests for the application with:
npm test
  • Start the Application with:
npm start

Technologies and services

  • Node.js
  • EchmaScript 6 (JavaScript 2015)
  • Angular.js
  • Jasmine (Test runner)
  • Gulp (Task runner)
  • Karma (Generate tests and coverage)
  • Travic CI (Continious Integration)
  • Coveralls (Test coverage percentage)
  • Hound CI (Check for style violations)
  • HTML/CSS (Frontend)
  • Code Climate

Contributions

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

About

Project files for the 'Inverted Index' Javascript checkpoint

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages