This project implements a faceted search application using Python. The application is designed to allow users to search and filter through a dataset with multiple facets.
- Python 3.11 or higher
- Git
- PyCharm (optional but recommended for ease of setup)
Clone the project from the GitHub repository:
git clone https://github.com/shivakumarzishnuviknesh7/Human-Machine-Interface-:master.git
cd Human-Machine-Interface
Set up a virtual environment using Python 3.11+:
- Open PyCharm and select "Open" from the "File" menu.
- Navigate to the project directory and click "Open".
- PyCharm may prompt you to create a virtual environment. If not, you can manually set it up:
- Go to
File
>Settings
(orPyCharm
>Preferences
on macOS) - Navigate to
Project: faceted-search-project
>Python Interpreter
- Click on the gear icon and select
Add...
- Choose
Virtualenv Environment
and ensure the base interpreter is set to Python 3.11+ - Click
OK
to create the virtual environment.
- Go to
python3.11 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
Install the required packages mentioned in requirements.txt
:
pip install -r requirements.txt
Start the server by running server.py
:
python server.py
In a new terminal, navigate to the frontend
directory and run the Streamlit app:
cd frontend
streamlit run app.py
Once the server and the Streamlit app are running, you can access the faceted search interface through your web browser. Navigate to the URL provided by Streamlit (typically http://localhost:8501
).
Feel free to fork the repository and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the MIT License. See the LICENSE
file for details.