Skip to content

🏊 Diver is a small open-source search engine for local documents. the search engine uses OCR to recognize text inside images.

License

Notifications You must be signed in to change notification settings

JustPowerful/Diver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Diver - Local Document Search Engine

Diver is a powerful local document search engine built using Node.js Express and React. It incorporates Optical Character Recognition (OCR) technology to recognize text within images, enabling efficient searching within supported file formats.

Features

  • OCR Integration: Utilizes OCR to extract text from images, enabling indexing and searching within image files.
  • Supported File Formats: Diver supports the following file formats for indexing and searching:
    • PDF
    • PNG
    • JPG
    • TXT
    • DOCX (Word)
    • XLSX (Excel)
    • PPTX (PowerPoint)
  • Responsive UI: The user interface is built using React, ensuring a seamless and responsive experience across devices.
  • Fast and Efficient: Employs Node.js Express for the backend, providing fast and efficient document indexing and search capabilities.

Installation

To install Diver, follow these steps:

  1. Clone the repository: git clone https://github.com/JustPowerful/diver.git
  2. Navigate to the project directory: cd diver
  3. Install dependencies for both the server and client:
    cd server
    npm install
    cd ../client
    npm install
    

Usage

Once installed, you can start using Diver by following these instructions:

  1. Start the server:
    cd server
    npm start
    
  2. Start the client:
    cd client
    npm start
    
  3. Access Diver in your web browser at http://localhost:3000.

Authors:

  • Ahmed Amine Doudech (Username: JustPowerful)

Contributing

Contributions are welcome! If you'd like to contribute to Diver, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature: git checkout -b feature-name
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin feature-name
  5. Submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • This project utilizes Tesseract for OCR.

Contact

For any inquiries or support, feel free to contact the project maintainer at ahmedaminedoudech@gmail.com.

Thank you for using Diver! Happy searching! πŸŒŠπŸ”

About

🏊 Diver is a small open-source search engine for local documents. the search engine uses OCR to recognize text inside images.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published