Voile
_{A personal book reading app.}

Voile is a app designed for personal book reading that supports various file formats. It allows users to store their preferred book format, be it a folder of images or texts, for easy reading.

Bookshelf icons created by Freepik - Flaticon

Target

Will Provide

• Support books format:
  • A folder of images
  • A folder of txts
  • One txt (Maybe large)
  • pdf
  • epub
• Operations:
  • Upload/Remove books
  • Edit book information
  • Group books into a series
• Single-user login with password authentication.
• Single binary executable.

May (or may not 😝) Provide

• Offers WebDAV as an alternative source for books.

Won't Provide

• Multi-user
• Crawler
• Native GUI

How to build

cargo build

How to Run

To run the program, you need to specify a settings directory. If you start the program without any arguments, it will use the default folder depending on your operating system:

• Linux: $HOME/.config/Voile/
• Windows: %APPDATA%\Voile\
• macOS: $HOME/Library/Application Support/Voile/

To start the program with a specific path to the configuration folder, you can run the following command:

./app [config_dir]

Replace [config_dir] with the desired path to the folder containing the configuration files. This allows you to override the default settings directory and specify a custom location for the configuration files.

TODO

• Easy configuration
• Use rust-embed to embed prebuild frontend
• Search
• Tag Filter
• Add zip
• Upload book cover
• PDF Book
• i18n

License

MIT