Awesome

<p align="center"> <img align="center" src="/docs/img/readme/logo.png" alt="Boomega icon"> <h1 align="center">Boomega <a href="https://github.com/Dansoftowner/Boomega"><img align="center" alt="Unstable stage" src="https://img.shields.io/badge/stage-unstable-red"></a></h1> </p> <p align="center"> <a href="LICENSE"><img align="center" alt="License" src="https://img.shields.io/github/license/DansoftOwner/Boomega"></a> <a href="https://github.com/Dansoftowner/Boomega/issues"><img align="center" alt="Issues" src="https://img.shields.io/github/issues/DansoftOwner/Boomega"></a> <a href="https://github.com/Dansoftowner/Boomega/issues"><img align="center" alt="Issues closed" src="https://img.shields.io/github/issues-closed/Dansoftowner/Boomega"></a> <a href="https://github.com/Dansoftowner/Boomega/commits/dev"><img align="center" alt="Last commit" src="https://img.shields.io/github/last-commit/Dansoftowner/Boomega"></a> </p> <h3 align="center">An advanced book explorer/catalog application written in Java and Kotlin.</h3>

Screenshot

✨ 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!

<table> <tr> <td align="center"> <b> <h1> <img style="margin-right: 10px" src="docs/img/readme/windows.png" alt=""> Windows </h1> </b> <p><b>(64-bit)</b></p> </td> <td align="center"> <b> <h1> <img style="margin-right: 10px" src="docs/img/readme/linux.png" alt=""> Linux </h1> </b> <p><b>(64-bit)</b></p> </td> <td align="center"> <b> <h1> <img style="margin-right: 10px" src="docs/img/readme/mac.png" alt=""> MacOS </h1> </b> <p><b>(64-bit)</b></p> </td> </tr> <tr> <td> <b> <ul> <li> <h4> <a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/Boomega-0.7.5-win.exe">Exe installer (.exe)</a> </h4> </li> <li> <h4> <a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/Boomega-0.7.5-win.msi">MSI installer package (.msi)</a> </h4> </li> <li> <h4> <a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/Boomega-0.7.5-win.zip">Portable (.zip)</a> </h4> </li> </ul> </b> </td> <td> <b> <ul> <li> <h4> <a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/boomega_0.7.5-1_amd64-linux.deb">Debian Software Package (.deb)</a> </h4> </li> <li> <h4> <a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/Boomega-0.7.5-linux.tar.xz">Portable (.tar.xz)</a> </h4> </li> </ul> </b> </td> <td> <p><b><i>Help wanted</i></b></p> </td> </tr> <tr> <td align="center" colspan="3"> <b><a href="https://github.com/Dansoftowner/Boomega/releases/download/v0.7.5/Boomega-0.7.5-all.jar">Java archive (.jar)</a></b> </td> </tr> </table>

⌨️ 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. <br/> To build a fat jar, use gradlew shadowJar. <br/> 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.