File Search Engine

Description

This project implements a Python-based file search engine that searches for a target file in a specified directory, ignoring file name case sensitivity.

Features

• Fast searching using Python
• Easy setup with Docker
• Flexible search parameters

Prerequisites

• Python 3.10+
• Docker (for Docker setup)

Setup Instructions

Traditional Setup

1. Clone the repository:

   git clone https://github.com/aleko-khomasuridze/File-Search-Engine.git

2. Navigate into the project directory:

   cd File-Search-Engine

3. Install dependencies:

   pip install -r requirements.txt

4. Run the application:

   python main.py

Docker Setup

1. Build the Docker image:

   docker build -t filesearchengine .

2. Run the container:

   docker run -d -p 8080:8080 filesearchengine
   

Usage

This section guides you through the main functionalities of the application using the main screen interface.

Step-by-Step Instructions

1. Select the Search Directory:

   • Click on the folder icon to open a directory dialog box where you can navigate to and select the directory you want to search.
   • Alternatively, you can manually enter the complete directory path in the Folder Path field.

2. Specify the File Name:

   • Enter the name of the file you are searching for in the File Name field. The application handles case sensitivity, so you don't need to worry about it.

3. Define the File Extension:

   • Input the extension of the file you are looking for in the Extension field to narrow down the search.

4. List All Files by Extension:

   • Click on List All to display all files within the specified directory that match the given file extension.

5. Perform the Search:

   • Once all fields are filled, click the Search button to initiate the search. The application will then display a list of all files that contain the name specified in the File Name field.

6. Open File from List

   • Once all the files have been listed in the Table, You can click on the eye button in actions column to open the target file.

These steps will help you efficiently utilize the application to find files based on name and extension within a chosen directory.

Contributing

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