This project is built on Python 3.9.x and Django 4.x.

Use the package manager pip to install requirements.

pip install -r requirements.txt

Copy the values from the example.env file to a new .env file in the same directory. You can edit the values to suite your credentials.

CD into the searchengine folder that contains the manage.py

Run python manage.py runserver

This will take approximately 30 seconds - 1 minute on the initial run depending on your network/signal strength. The process of downloading a vital package nltk_punkt is run once at the beginning of this process. Subsequent server runs on the same system will not require this process.

Visit Search to run a search query.

Visit Index to save a document string to DB.

View the process flow of the system here: FLOW DIAGRAM

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.