Skip to content

sorablaze11/TapSearch

Repository files navigation

🌑 TapSearch

A simple search engine for documents based on inverted-index. ReactJs for frontend and Djano Rest Framework for Rest API.
Deploying frontend on Github pages and backend on heroku.

Backend:- https://quiet-badlands-42446.herokuapp.com/api/

USECASE:

Can be used to index documents and words in the document.
Can be used to search words present in different documents.

REST APIs:

index: Index the entrered set of paragraphs.
search: Search for the given words in the documents.
getALl: View all the documents present in the db.
clear: Clear all the indexes in the db.

TECHSTACK:

Python
Django
Django Rest Framework
ReactJs
Heroku

How to use:

Given the frontpage of the TapSearch website. Click on Index

drawing

Enter the documents or paragraphs to be indexed and press index it.

drawing

Go to search page and search for the specific word in each document.

drawing

drawing

Go to All Documents to get all the documents that has been indexed.

drawing

Press clear to clear all the indexed documents.

drawing

Future Prospects

The given webapp can be further improve by adding phrase indexing. so that we can seach for phrases.
The search can be modified search that we can get all the paragraphs that contains the word the user has typed untill now.

Instructions to run locally as backend server might crash.

  1. Clone the repo.
    git clone https://github.com/sorablaze11/TapSearch.git
  2. Install python and nodejs if you don't have it installed in your laptop/desktop.
  3. At the project folder. Enter the below code to install all the libraries.
    pip install -r requirements.txt
  4. Go to backend and enter to run the backend searver.
    python manage.py runserver
  5. Go to frontend and enter the below code to install the dependencies.
    npm i
  6. After that type the below code to run frontend server.
    npm start
  7. Now go to below link to access the webapp.
    http://127.0.0.1:3000/