adhadse / bookx Goto Github PK

View Code? Open in Web Editor NEW

29.0 5.0 2.0 26.15 MB

A Modern, Open Source GTK4 ebook manager powered by Rust.

License: GNU General Public License v3.0

Shell 4.99% Meson 15.86% CSS 1.09% Rust 78.07%

ebook ebook-editor ebook-reader gtk4 libadwaita modern ebook-manager rust rust-lang gnome

bookx's Introduction

Bookx

An MVP in progress:

Mockups
- Mockup for Library
- Mockup for Reader
- Mockup for editor
An ebook reader with .epub support
- Context menu for each book (delete, rename book, info)
- On click switch the carousal to the book
Ebook editor for .epub files

Pronunciation

The app is pronounced just like "Books" but the "s" replaced with "x", as in an extension of something that manages your books. And not "Book-ex" :)

Build & Run the project

Building the project

flatpak install org.gnome.Sdk//43 org.freedesktop.Sdk.Extension.rust-stable//22.08 org.gnome.Platform//43
flatpak-builder --user flatpak_app build-aux/com.adhadse.Bookx.Devel.json

To run the project

flatpak-builder --run flatpak_app build-aux/com.adhadse.Bookx.Devel.json bookx

Please note that these commands are just for demonstration purposes. Normally this would be handled by your IDE, such as GNOME Builder or VS Code with the Flatpak extension.

Wanna learn? Come and Contribute!

For those doing there first-time contribution, check our good first issue.

Go through the issue, can you understand them? Talk to devs and understand how to proceed. And if yes, try compiling it on your system.
This project uses Rust, so a good understanding of Rust is prerequisite, check out The Rust Programming Language Book.
If interested in design, file an issue, explain your need, and update mockups!
This is a GNOME app, so do read GNOME Human Interface Guidelines, it's interesting what goes behind making apps for our users.
Beyond that even filing an issue and reporting failure and feedback is counted as contribution.

Dependency libraries and documentation is in _developer folder.

For seasoned folks, skip ignore good first issue, and dive in.

bookx's People

Contributors

Stargazers

Watchers

Forkers

kianmeng umairahmadh

bookx's Issues

Set up Status Page, Preferences and Toast.

Remove as many `expect()` and `unwrap()` as possible and replace them with `match` expressions.

Something to do before releasing it for public use.

Write ` src/ui/library/library_book_box.rs`

For reference use this not working code.

Change pages dir to library.

Implement:

Write `library/book/book_data.rs`

This will store BookxLibraryBookData struct storing:
- identifier: id of book
- _type: the type of book
- storage: path to book
- cache: cache dir for book
- cover_path: cover path for book
- view_set
- annotations_map: annotations mapping from cfi to color
- annotations_list: Liststore.
Method to implement:
- load_data(): function to load data about book
- add_annotation(): add annotations to book
- remove_annotation(): remove annotations
- add_bookmark(): add bookmark
- remove_bookmark(): remove bookmark
- add_view(): add view to view_set
- delete_view(): delete view from view_set
- save_cover(): save cover as png file to cache dir

Setup process to load book and log relevant error.

What kind of error is with loading a book?

Work on Bookx Reader Mode and library

Add top section in library to allow a reader to continue reading where he left.

The title says it all.

When the user hasn't begun reading anything just provoke him to read with good message.
Otherwise, tell user to continue the book where he left.

Switch to MVC design pattern for `src` directory

Currently, the structure looks janky. My engineering skills should help me little bit.
Structure right now:

library: handles internal state of library
settings: global setting module
ui: handles everything related to UI.

Changes afterward:

models: module for model/data of individual components or entity here book, annotation, bookmark, how is it structured
views: how that model is going to be read to become usable for widgets.
widgets: forward facing module interacting with gtk widgets.

Take Read It Later as inspiration.