Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 5.82 KB

README.md

File metadata and controls

88 lines (70 loc) · 5.82 KB

GitHub issues GitHub forks GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub stars GitHub contributors Lines of code

Readile

Readile

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

Readile

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

User Requirements

Readile

  • 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.

image

Database ER Diagram (SQL Schema)

readile

System Design & Architecture

Utilized the MVC design pattern

image

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.

main - develop

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.

Interface

Used Libraries & Technologies

Technologies

Screenshots

Screenshot2 Screenshot1 Screenshot3 Screenshot4

Guides

The following guides illustrate how to use some features concretely:

Contact Details

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

© 2023 Readile