Search Engine

A customized search engine built on top of SearxNG, designed to inspect and possibly re-rank search results by detecting biases, ensuring that users receive diverse information.

Table of Contents

• Installation
  • Prerequisites
  • Setup
• Usage
• Contributing
• License
• Contact

Installation

Prerequisites

Ensure you have the following installed:

• Python 3.8 as a base programming environment.

Setup

1. Clone the repository:

git clone https://github.com/ngi-indi/module-search.git
cd module-search

2. Set up the virtual environment (optional but recommended):

• On Windows:

python -m venv venv
.\venv\Scripts\activate

• On macOS/Linux:

python3 -m venv venv
source venv/bin/activate

3. Install dependencies:

Install the required Python packages by running:

pip install -r requirements.txt

Usage

1. Build the Docker image:

Run the following command to build the Docker image.

docker build -t searchengine .

2. Start the Searx server:

After the image is built, start the container with the following command

docker run -d --name searchengine --network indi_network -p 8080:8080 searchengine

3. Access the web interface:

Open your browser and go to http://127.0.0.1:8080/.

Contributing

Reporting bugs and requesting features

• If you find a bug, please open an issue.
• To request a feature, feel free to open an issue as well.

Developing a new feature

1. Fork the repository by clicking the "Fork" button at the top right of this page.
2. Clone your fork locally:

   git clone https://github.com/ngi-indi/module-bias-manager.git

3. Create a new branch for your feature or bug fix:

   git checkout -b feature-branch

4. Make your changes. Please follow the existing code style and conventions.
5. Commit your changes with a descriptive commit message:

   git commit -m "Add new feature: explanation of bias model predictions"

6. Push to your fork:

   git push origin feature-branch

7. Open a pull request from your fork’s branch to the main branch of this repository.

• Describe the changes you’ve made in the pull request description.
• Ensure that your pull request references any relevant issues.

License

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

Contact

For any questions or support, please reach out to:

• University of Cagliari: [email protected], [email protected], [email protected], [email protected]
• R2M Solution: [email protected]
• Website: Coming soon!