An Inverted Index is an Index Data Structure storing a mapping from content to location (i.e. a mapping of words or numbers to it's location in a database file). It use the elasticsearch method, which is designed to allow very fast full-text searches. The link to the hosted app Meek-Inverted Index
- Upload file(s)
- Create an index for uploaded file(s)
- Search through indexed files
The project implements Elasticsearch also known as Inverted Index which is known to achieve fast search responses because instead of searching the text directly, it searches an index instead.
- Requirements
- To run the app locally, you need to have
node.js
installed
- To run the app locally, you need to have
- How to setup the project/Installation/Configuration
- Clone the repo
git clone https://github.com/andela-moseni/inverted-index.git
- Change directory into
inverted-index
folder - Run
npm install
to install all dependencies - Run
npm start
to run the application
- Clone the repo
- How to run tests
- Run
npm test
- Run
When the app has started:
- Click on
Upload File
to upload valid JSON file(s) - Upon successful upload, click on the
Create Index
button - Scroll down the page to see the created Index displayed in a tabular format
- Choose a file to search through a file or
All files
to search through all files, input search words and results will be displayed
- Node JS
- ES6
- AngularJS
- Gulp
- Karma
- Jasmine
The application can only upload JSON files in this format
- Fork this repositry to your account
- Clone your repositry -
git clone https://github.com/andela-moseni/inverted-index.git
- Create your feature branch -
git checkout -b new-feature
- Commit your changes -
git commit -m "did something"
- Push to the remote branch -
git push origin new-feature
- Open a pull request
- For further research on Inverted index, click here
- MIT
- Halimat Mercy Oseni