NimbleAndy/SearchEngine

Once you save and unzip the folder

Navigate to the project directory:

cd C:FolderPath\FinalProject   

Then change into the microsearch directory by

cd microsearch

Then Create a python virtual environment

python -m venv venv

After activating the environment you should still be in microsearch after creating the virtual environment

venv\Scripts\activate

and install the package and the dependencies

pip install .

after installation launch the app

python -m app.app --data-path output.parquet

and if you navigate to http://127.0.0.1:8000/ you'll be able to query the engine.

Here's how to add the test running instructions to your README:

# Running the App
After installation launch the app
```bash
python -m app.app --data-path output.parquet

Navigate to http://127.0.0.1:8000/ to query the engine.

Running Tests

To run the test suite (make sure you're still in the microsearch directory with venv activated):

1. Run all tests:

python tests/test_engine.py

2. Or use pytest for detailed test reporting:

pytest tests/test_engine.py -v

The test suite includes:

• 70 test documents
• 50+ test queries
• Evaluation metrics (Precision@10, Recall@10, MRR, NDCG)
• Tests for document expansion and query expansion