Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
PORT=3000
14 changes: 14 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
css/
samples/
node_modules/
images/
spec/lib
spec/support
spec/*.html
.codeclimate.yml
.env
.hound.yml
*.html
karma.conf.js
Profile

5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.DS_Store
node_modules/
test.js
testclass.js
coverage/
4 changes: 4 additions & 0 deletions .hound.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
eslint:
enabled: true
config_file: .eslintrc.json
ignore_file: .eslintignore
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
sudo: required
dist: trusty
language: node_js
node_js:
- 6
before_script:
- npm install
script:
- npm test

before_install:
- export CHROME_BIN=chromium-browser
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start

after_script:
- cat ./coverage/**/lcov.info | ./node_modules/coveralls/bin/coveralls.js
1 change: 1 addition & 0 deletions Profile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: node server.js
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[![Coverage Status](https://coveralls.io/repos/github/andela-aonifade/dplex/badge.svg?branch=development)](https://coveralls.io/github/andela-aonifade/dplex?branch=development)
[![Code Climate](https://codeclimate.com/github/andela-aonifade/dplex/badges/gpa.svg)](https://codeclimate.com/github/andela-aonifade/dplex)
[![Build Status](https://travis-ci.org/andela-aonifade/dplex.svg?branch=development)](https://travis-ci.org/andela-aonifade/dplex)

# DPlex - Inverted Index
DPlex is an inverted index word search application. It's an application that help you index books and search through indexed books. It is easy to use and free for anyone who cares to use it.
**DPlex** allows users to rapidly index documents in a JSON format of the form below and search through all indexed document to view the words contained in each documents.

## Features of the application
- Allow upload of json files of the format below
```
[
{
"title": "This is a sample title",
"text": "And this is a sample text"
}
]
```
- Indexing of uploaded files
- Searching of each indexed files and all indexed files

## How to use
The application can be accessed on heroku via [https://dplex-staging.herokuapp.com](https://dplex-staging.herokuapp.com).
It can also be used locally by following the steps below

1. Clone the repository `git clone https://github.com/andela-aonifade/dplex.git`
2. Move into the repository directory `cd dplex`
3. Run `npm install` to install all the dependencies. The application is build on [Nodejs](nodejs.org) `npm install`

### Dependencies
- gulp
- coveralls (test coverage reporting)
- karma (test)
- eslint (code style)
- jasmine-core
4. Start the application by executing the command below `npm start` or `gulp`
5. To run tests, you can run the command below `npm test` or `gulp lint`

## Limitation
- The application can not be distinguished between plural and singular words. It also does not distinguish between the past tense form of a verb. It does not identify synonyms and sees numbers as string

## More information
- [Inverted Index - Wikipedia](https://en.wikipedia.org/wiki/Inverted_index)
- [Inverted Index](https://www.elastic.co/guide/en/elasticsearch/guide/current/inverted-index.html)
16 changes: 16 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "dplex - Inverted Index For All",
"description": "Heroku generated json file",
"scripts": {
},
"env": {
},
"formation": {
},
"addons": [

],
"buildpacks": [

]
}
Loading