booky

booky is a minimalistic TUI tool for managing your growing book collection.

It is writtin in Rust and uses diesel as it's orm together with sqlite. The tui is created using the awesome Rust crate called ratatui

Motivation

After learning Rust for 10 days I wanted to start a small project that I could personally use. I live inside my terminal like the cool kids, so I wanted to create a small tool that could make it easy for me to manage my growing book collection.

Reading is fun, but I quickly forget which books I've read in a month/year. Or how many books of an author I have personally read. I want a simple tool that shows me my current list of books and allows me to see statistics like:

• Books read in the month of April
• Books read in 2023
• You've read 20 fictional books in 2020, etc.

As of now, booky can only perform CRUD operations and allows for a basic search on book titles. I plan to add more features as can be seen in the TODO section.

This project suffers from noobiness, I'm learning Rust and a bunch of things at the same time. I'm doing a lot of yucky experiments to gain knowledge, feel free to tell me my code sucks and how I can improve it. You can ofcourse also do a pr to add features or write better code.

Features

• Basic Vim movement: Use jk to move and / to search.
• Ability to search books
• Sqlite database so you can store more books than you can read (and bring your collection everywhere) ;)
• Works in the terminal, you can now look cool adding books!

Showcase

Building and Installing

• Make sure you have Rust installed.
• Clone this repo and cd into it.
• Build the project using cargo b --release
• The binary can be found in target/release/booky

If all goes well, booky will create a directory in /documents/booky containing a empty books.db

Keybindings

• ? -> To open help menu.
• i -> Insert a new book.
• d -> Delete current highlighted book (no confirmation).
• u -> Update current highlighted book.
• jk or up/down -> To change selected book.
• / -> Search for a book.
• r -> Clear search
• q -> Quit booky

TODO

• Refactor a bunch of code.
• Make booky render the ui better on smaller terminals, currently booky works best on a full screen terminal.
• Make booky look a little nicer with more colors.
• If a book is unfinished, don't show days.
• If users only enter a year default to the first month and day of the given year.
• Create a statistics tab that shows you how many books you've read this month/year, how many per genre and more.
• Add a logger to booky that shows the user if changes were made to the db like an CRUD operation
• Add ability to export your books in json format, that way you can use them on your website I guess?
• Better error handling

Contributions

I'm a rust noob, contributions are always welcome. Feel free to create an issue and to @ me.

If there is something that I'm doing very wrong (likely the case), don't hold back and just tell me. The goal of this project is to learn, but I also want to make it a tool that other people could use.

Acknowledgements/Inspiration

I wouldn't be able to create booky without an awesome project called kanban-tui

I took a lot of inspiration from Joseph Ferano's kanban-tui project, it helped me understand how I could create "forms" that I could use for adding/searching in booky. Check his cool project out!

License

booky is licensed with the MIT license. Check the LICENSE file for more info.