dansoftowner/boomega

A modern book explorer/catalog application written in Kotlin and Java.

Boomega

An advanced book explorer/catalog application written in Java and Kotlin.

✨ Features

• Cross-platform
• Dark/Light theme, modern UI
• Multiple UI languages
• Flexible to support multiple Database Management Systems (e.g MySql)
• Exporting to several formats like Excel Spreadsheets, JSON, etc...
• Custom notes with Markdown support
• Google Books synchronization
• Customizable key-bindings
• Plugin support
• ...and more!

📄 Documentation

• User guide - Detailed documentation
• Plugin guide - Guide for writing Boomega Plugins
• Default key-bindings

⬇️ Download

Note: If you want to try the latest version, you should build the project yourself!

Windows (64-bit)	Linux (64-bit)	MacOS (64-bit)
Exe installer (.exe) MSI installer package (.msi) Portable (.zip)	Debian Software Package (.deb) Portable (.tar.xz)	Help wanted
Java archive (.jar)

⌨️ Source code

• The repo has two important branches:
  • master - usually for permanent versions
  • dev - for developing the app further
• The code is written in Java and Kotlin mixed.
• The GUI toolkit used is JavaFX
• The app targets Java 17 but the project is unmodularized
• The build tool used is Gradle
• Want to contribute? See the contribution guideline.

🔨 Build

The recommended IDE for building this project is IntelliJ Idea.

Build requirements

• JDK 17 (recommended: OpenJDK)

Build manually (without using an IDE)

If you want to run the project, simply use gradlew run.
To build a fat jar, use gradlew shadowJar.
To build executable binaries, use gradlew jpackage (see distribution guideline)

🏋️ Acknowledgements

All acknowledgements (e.g. third-party libraries) are listed in this document.

💙 Support

If you like this project, give a ⭐!

📄 License

This software is licensed under the GNU General Public License v3.

boomega's Issues

E-book search support

There should be some kind of e-book searching functionality.

May help:
Websites to download pdf books
Archive.org -> advanced search

Searching for similar records when adding new records in RecordAddForm

When the user wants to add a new record, the program should show a confirmation-dialog that shows the already present items that are similar to the one that the user wants to add.

Double checking password in the database creator

If the user wants authentication, the password should be double-checked in the DatabaseCreator.

Clipboard viewer

There should be a 'clipboard-viewer/editor' panel that allows to see the RecordClipboard's content and even allows to edit it (remove elements etc..). (Should be launchable from the MenuBar)

Context menu in Google Books Import

The given Volume should have a ContextMenu that allows the user to import that.

Support reordering

Currently, reordering books is not supported.
The #30 issue may help because it should achieved with drag n drop too.

RecordAddForm: confirmation dialog when replacing google book connection

If the user adds a google-book connection and later wants to replace it, the program should show a confirmation-dialog.

Exporting records

Should support exporting to:

• PDF
  • See:
    - PDFBox
    - Boxable -> for pdf table exportation [PDFBox extension]
    - Easytable -> for pdf table exportation [PDFBox extension]
• JSON
• EXCEL
  • See:
    - Apache POI
• ACCESS
  • See:
    - UCanAccess -> A Pure Java JDBC driver for Access
    - Hibernate with Access
    - Tutorial
• HTML Table
  • See:
    - JSoup
• XML
• Plain text
  • See:
    - Stackoverlflow
    - java_text_tables

Confirmation dialog in RecordAddForm when importing Google Book

If the user already typed data into the RecordAddForm but also wants to import a google Volume, the program should show a confirmation dialog: 'Are you sure you want to override the data you already typed?' for example.

Search with enter in Google Books Import

The user should be allowed to search for the given terms with the Enter key in GoogleBooksImportView.

Regex character highlighting in find-panel

RichTextFX

How to highlight word found using regex in javafx

Added styled text fields to RichTextFX

Invalid regex message in RecordFindControl

If a regex is invalid, the control should show a label-message about that.

Drag n drop between different database tables

Cut/Copy functionality is now implemented (#24) but it would be great to drag n drop elements between the tables.

May help:
Drag & Drop in JavaFX table?
Drag-and-Drop Feature in JavaFX Applications
JavaFX Drag and Drop Cell in ListView

Check-menu-item style bug in Workbench toolbars

Notification on paste event

Ability to configure the maximum items count in the 'recent-databases' menu

There should be an option in PreferencesView that allows to set the maximum items count in the recent database menu located in the MenuBar.

Using JavaFX pagination in Google Books Import

Using a JavaFX Pagination would be better instead of a custom one in GoogleBooksImportView.

RecordsView: Saving the last RecordFindControl search term

The last term typed into the RecordFindControl should be saved for better user experience.

LoginView: selecting the dragged database

If the user draggs a database file into the LoginView it shouldn't be just added but also selected for better user experience.

Some google book data is lost when importing

The HTML format of the Volume's description is only available if we query it specifically by id.
When importing a Google Book volume, the volume should be pulled again to have the HTML format.

Also, in some cases even other field's data are lost.

Good-looking place-holder in RecordsView

Key combinations on LoginView

Some key combinations should be available on LoginView .
Using Scene.accelators

UpdateDialog: ability to open the downloads website

The UpdateDialog should give the ability to the user to open the (Github) download website for the packages.

Advanced/dev setting in PreferencesView

There should be a tab for advanced settings like:

• calling System.gc()
• Setting the logger level dynamically
• etc...

Find panel in record-viewer

There should be a find-panel in the RecordsView. It should be launchable through a ToolbarItem and the Ctrl+F key combination.
It should support regex etc..

Showing the package-size in UpdateDialog

The UpdateDialog should show the size of the particular package in MBs

Some LoginView configurations are not saved when restarting the program

The login window close event handler is not executed when restarting the program. It's a problem because some configurations will not be saved in that case.

Select-all toolbar item in RecordsView

Confirmation dialog before deleting a record

Cutting/Copying records from one database to another

Last launch of a database should be saved

The time when a database is opened should be saved.
It would be useful because:

• The 'Recent databases' menu in the MenuBar could be sorted better
• The User could see it in the DatabaseManager

Database file management options

There should be configurable preferences for (nitrite) database file management:

• compress data
• auto commit buffer size

Wikipedia search support

There should be a feature in RecordsView and in RecordContextMenu that allows the user to search for a particular record-field on Wikipedia.
WikipediaSearchOverlay -> lists the results and allows the user to open them in the default browser.

May help:
Searching Wikipedia using API
Wikipedia API
+1
Example: https://en.wikipedia.org/w/api.php?action=opensearch&search=Jules+Verne

RecordEditor: save key combination

In the Notes tab the save key combination is working but not in the Fields tab.

Saving the time of the last update-searching

Everytime the program looks for updates, it should also save the particular time too.
The PreferencesView should allow the user to see that in the "Updates" tab.

More verbose Google Book Preview

If a preview is not available the Google Book Preview should tell the user that.

Not enough indication about loading books in RecordsView

When RecordsView is launched , there is no indication about the database-loading.

LanguageSelection improvement

A language-selection-field doesn't display the user-friendly version of the particular Locale. It should show it in a Tooltip.

Signing out of an opened database

There should be an item for signing out/closing the opened database. It should also remove the auto-login from that database in that case.

RecordEditor: incorrect save-button disable policy

If we change the rating of a Record in the RecordEditor and save it, the save-button is not disabled.

RecordEditor: fields-editor misbehaviour

If a value is changed in the Fields tab and then if I navigate to the Notes tab and navigate back, the unsaved changes are handled as they are already saved so the save-changes button is disabled.

Exporting a specific note to HTML & PDF

There is an already opened issue (#41) that calls for exporting functionality.
But there should be an exporting functionality for notes that allows to export a specific note into HTML and PDF.

For PDF exportation:
openhtmltopdf
how to create pdf from html using PDFBox

RecordsView: Google Book Dock late bug

If a record is deleted while the Google Book Dock loads -> the google book dock caches the content and won't be clean

Database info panel

In every MainView the user should have the ability to read some information about the launched database.
It's name, path, size etc...

The MenuBar's File menu is a good place for it.

Limited mode

The app should have a limit mode, where no local database is required and activites that are independent of a local database (like Google Book search) are available.

Specifying language with a .properties file

The user should have the ability to register his own .properties file for translating the UI.

LanguagePack>FileLanguagePack

UpdateDialog default directory

The user's Downloads directory should be the default destination for update-binaries.

Dependency table shows unrelated licenses

Handling duplicate file in UpdateDialog

If the user wants to download a binary but in the destination directory there is a file already with the same name, the program should show a confirmation dialog (like: 'Do you want to override...) or it should append a number to the new file's name (ex.: 'Binary (1)'.

Status bar

There should be a status bar at the bottom where the program can show messages and progress.