https://github.com/devzbysiu/dox

Index and search your documents
https://github.com/devzbysiu/dox

Last synced: about 2 months ago
JSON representation

Index and search your documents

• Host: GitHub
• URL: https://github.com/devzbysiu/dox
• Owner: devzbysiu
• License: apache-2.0
• Created: 2022-01-21T19:39:09.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-30T16:05:23.000Z (almost 2 years ago)
• Last Synced: 2024-08-08T00:44:21.690Z (5 months ago)
• Language: Rust
• Homepage:
• Size: 5.77 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• project-awesome - devzbysiu/dox - Index and search your documents (Rust)

README

        


  
dox


  


    DOcuments indeXer

  


  

    

      core

      client

    

    

      

        


          

        

      

      

        


          

        

      

    

  


  


  


    About

     | 

    Demo

     | 

    Installation and Configuration

     | 

    License

     | 

    Contribution

  


  
Built with 🦀 and 





# 
About


> :warning: This is still in progress and undergoes heavy refactoring, so it should be considered

unstable.

One of the most frustrating activities I had to do from time to time is to search through a pile

of documents to find the one I'm looking for. Wouldn't be better to just open an app and type

keywords in the search bar?

That's what this project is for. TLDR: you install a [core](./core) on your PC. Through the

configuration file, you tell it which directory should be watched for new files. Every time new

file appears, core will extract the text from the file and index it.

You also install [client](./client) app on your smartphone. It allows you to list and search

scanned files. It also allows scanning new documents by using a camera or just picking a PDF.

# 
Demo


## --- TODO ---

# 
Installation and configuration


## Core

1. Go to [releases](https://github.com/devzbysiu/dox/releases) and download binary for your system.

2. Run `dox init`. It will display a CLI, so you can configure it:

  1. `watched_directory` - a directory which is monitored for new files. If you are going to scan

     documents through your printer, use the directory to which your printer is saving scanner files.

  2. `index_dir` - directory holding and indexed text.

  3. `cooldown_time` - time after which the buffered files will be indexed.

3. After configuration, the `dox` server will be exposed on port `8000`. Keep this in mind, you'll need

   to point the client to the `dox` server

## Client

--- TODO ---

1. Go to [releases](https://github.com/devzbysiu/dox/releases) page and download APK file.

2. Install it on your device.

3. Run the app. On first run, it will show you settings page:

  - `dox address` - the address of the dox server

  > **NOTE**: the dox server needs to be accessible to the client. If you are setting the core

  on local machine, make sure that the phone is on the same network as the local machine.

# 
License


This project is licensed under either of

- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

# 
Contribution


Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the

work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any

additional terms or conditions.