| core | client |
|---|---|
|
|
|
⚠️ 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 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 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.
- Go to releases and download binary for your system.
- Run
dox init. It will display a CLI, so you can configure it: 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.index_dir- directory holding and indexed text.cooldown_time- time after which the buffered files will be indexed.- After configuration, the
doxserver will be exposed on port8000. Keep this in mind, you'll need to point the client to thedoxserver
--- TODO ---
- Go to releases page and download APK file.
- Install it on your device.
- 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.
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.
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.