README.md

Readile

A simple yet powerful desktop application that tracks users’ book reading activity and allows them to create reading goals.

Readile bridges the gap between user readings and their reading habits, allowing them to track their readings effortlessly

User Requirements

• As a user, I should be able to search for a particular book
• As a user, I should be able to track a particular book
• As a user, I should be able to categorize my books
• As a user, I should be able to delete a book
• As a user, I should be able to rate a book
• ...

Prototype & UI

• The prototype is designed using Figma.
• Each scene was designed separately using Scene Builder.

Database ER Diagram (SQL Schema)

System Design & Architecture

Utilized the MVC design pattern

Git Workflow

• Adopted the popular git feature branch based workflow.
• Each feature is developed in its own branch and a corresponding pull request is opened when it is finished.

CRUD Operations

• At this stage, we faced a serious issue in integrating the spring boot framework with javafx.
• The problem was solved by using the JavaFX Waver library.
• The Repository design pattern from Spring Data JPA is used to implement basic CRUD operations.

Used Libraries & Technologies

• JavaFX, JavaFX Waver, JFoenix, MaterialFX, ControlsFX, JavaSystemThemeDetector
• Spring Boot, Spring Security
• MySQL DBMS, JDBC, Hibernate JPA, Spring Data JPA
• Lombok, Google API's, OAuth2, Open Library API, Unsplash API

Screenshots

Guides

The following guides illustrate how to use some features concretely:

• Accessing Relational Data using JDBC with Spring
• Managing Transactions
• Accessing Data with JPA
• Accessing data with MySQL
• Using WebSocket to build an interactive web application

Contact Details

Feel free to reach out to us at: [email protected]

© 2023 Readile