https://github.com/qwefgh90/handyfinder

A handyfinder is tiny search program working on desktop to support multiple type of files.
https://github.com/qwefgh90/handyfinder

desktop-application javafx javafx-application lucene search-engine

Last synced: 4 months ago
JSON representation

A handyfinder is tiny search program working on desktop to support multiple type of files.

• Host: GitHub
• URL: https://github.com/qwefgh90/handyfinder
• Owner: qwefgh90
• License: apache-2.0
• Created: 2016-04-24T15:26:15.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-15T03:38:19.000Z (over 7 years ago)
• Last Synced: 2025-01-05T12:29:14.887Z (5 months ago)
• Topics: desktop-application, javafx, javafx-application, lucene, search-engine
• Language: Java
• Homepage: http://qwefgh90.github.io/handyfinder/
• Size: 140 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# handyfinder

[![Build Status](https://travis-ci.org/qwefgh90/handyfinder.svg?branch=master)](https://travis-ci.org/qwefgh90/handyfinder)

A handyfinder is tiny search program working on desktop to support multiple type of files

# Downloading

- You can download released versions from:  https://github.com/qwefgh90/handyfinder/releases

# Usage

1. In index page, add directories you want to index

2. and then "click run"

3. In search page, type keyword and search

# Functionality

- graphical interface like web

- index of files on file systems

- a index update when required

- file's meta data show (modified timestamp, filename, path, size)

- opening dir and files

- management of index based on directory which is visited recursively

- filters when searching

- a limit of disk usage

# System Feature

- a application is designed with Angularjs 1.5.5, bootstrap 3.3.6, angular-ui-bootstrap 1.3.2, javafx webview

- frontend is SPA (Single Page Application)

- backend is Restful API with embedded tomcat

- only local ip binding (127.0.0.1) 

- a lucene is used for indexing & search

- JSearch is used for body text of document which tika supports

# Run & Test

- When you want to contribute, use STS

- When you want to test, type "mvn clean test"

- When you want to make native binary, type "mvn jfx:native" (for windows, download Inno from http://www.jrsoftware.org/)

# Contribution

We would welcome any thoughts. When you find bugs, you can write issue and PR to "develop" branch.