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!

⌨️ 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.