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
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" :)
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.jsonTo run the project
flatpak-builder --run flatpak_app build-aux/com.adhadse.Bookx.Devel.json bookxPlease 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.
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.