https://github.com/dansoftowner/boomega

A modern book explorer/catalog application written in Kotlin and Java.
https://github.com/dansoftowner/boomega

books catalog client-side cross-platform database desktop explorer google-books gui java javafx kotlin

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dansoftowner/boomega
• Owner: Dansoftowner
• License: gpl-3.0
• Created: 2020-09-15T16:57:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-17T18:31:23.000Z (over 2 years ago)
• Last Synced: 2024-02-14T18:32:51.295Z (about 1 year ago)
• Topics: books, catalog, client-side, cross-platform, database, desktop, explorer, google-books, gui, java, javafx, kotlin
• Language: Kotlin
• Homepage:
• Size: 29.2 MB
• Stars: 70
• Watchers: 3
• Forks: 4
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Boomega 





    

    

    

    



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


![Screenshot](docs/img/readme/main-activity-preview.png)

## ✨ 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](docs/USER_GUIDE.md) - Detailed documentation

* [Plugin guide](docs/PLUGIN_GUIDE.md) - Guide for writing Boomega Plugins

* [Default key-bindings](docs/DEFAULT_KEYBINDINGS.md)

## ⬇️ Download

[![Platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey?logo=linux&logoColor=white)]()

[![Downloads](https://img.shields.io/github/downloads/DansoftOwner/Boomega/total)](https://github.com/Dansoftowner/Boomega/releases)

[![Version](https://img.shields.io/github/v/release/Dansoftowner/Boomega?include_prereleases)](https://github.com/Dansoftowner/Boomega/releases)

[![GitHub Release Date](https://img.shields.io/github/release-date-pre/Dansoftowner/Boomega?logo=googlecalendar&logoColor=white)](https://github.com/Dansoftowner/Boomega/releases)

> Note: If you want to try the latest version, you should [build](#-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

[![Java version](https://img.shields.io/badge/java-17-orange?logo=java&logoColor=white)](https://jdk.java.net/17/)

[![Kotlin version](https://img.shields.io/badge/kotlin-1.6-purple?logo=kotlin&logoColor=white)](https://kotlinlang.org/)

[![Top language](https://img.shields.io/github/languages/top/Dansoftowner/Boomega)](https://github.com/Dansoftowner/Boomega)

[![Gradle](https://img.shields.io/badge/gradle-7.0-green?logo=gradle&logoColor=white)](https://gradle.org/)

[![Gui](https://img.shields.io/badge/gui-javafx-blue)](https://openjfx.io/)

[![GitHub repo size](https://img.shields.io/github/repo-size/Dansoftowner/Boomega)](https://github.com/Dansoftowner/Boomega)

* 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](https://openjfx.io/)

* The app targets `Java 17` but the project is **unmodularized**

* The build tool used is [Gradle](https://gradle.org/)

* _Want to contribute?_ See the [contribution guideline](CONTRIBUTING.md).

## 🔨 Build

The recommended IDE for building this project is [IntelliJ Idea](https://www.jetbrains.com/idea/).

### Build requirements

* JDK 17 (recommended: [OpenJDK](https://jdk.java.net/17/))

### 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](distribution/DISTRIBUTION_GUIDELINE.md))

## 🏋️ Acknowledgements

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

## 💙 Support

If you like this project, give a ⭐!



## 📄 License

This software is licensed under the [GNU General Public License v3](https://en.wikipedia.org/wiki/GNU_General_Public_License).