Giter Club home page Giter Club logo

inverted-index's Introduction

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

inverted-index's People

Contributors

andela-ioraelosi 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.