- Description
- Class Diagram
- Entity Relationship Diagram
- Setup
- Technologies Used
- Controllers and Routes Structure
- Extra Links
- Future Work
- Resources
Greatreads is the final project of the Ironhack Java Backend Bootcamp. It is a Java API inspired by Goodreads, designed to provide a platform for users to discover and manage their reading preferences. It offers a simplified version of Goodreads' features while maintaining some of the core functionalities. With Greatreads, users can register, interact with books, and organize their reading lists effectively.
- User Registration and Management: Users can sign up for an account on Greatreads and manage their profiles. The platform supports multiple user roles:
- Admin: Administrators have access to administrative features such as managing users and books, adding genres, and deleting authors.
- Librarian: Librarians have access to a lower level of administrative features such as creating and updating books, authors, and translators.
- User: Regular users can explore books, authors, translators, and manage their reading lists.
-
Book Management: Greatreads offers the possibility to manage a reading list of books that users can explore. They can search for books by title, author, or genre.
-
User's Library: Each user has a library where they can manage their reading progress. The library includes manages the following reading stages:
- Want to Read: Users can add books they're interested in reading.
- Currently Reading: Users can track books they're currently reading.
- Read: Once users finish a book, they can mark it as read.
- Authentication and Authorization: Greatreads ensures secure access to user accounts through authentication mechanisms. Different user roles have varying levels of access, ensuring that administrators, librarians, and regular users can perform their respective tasks efficiently.
---
title: Greatreads
---
classDiagram
Person : -int id
Person : -String firstName
Person : -String lastName
class User {
-int id
-String name
-String username
-String email
-String password
}
class Role {
-int id
-String name
}
class Book {
-int id
-String title
-int numberOfPages
-String isbn
-Genre genre
-String language
-String publisher
-Author author
-List~BookStatus~ bookStatuses
}
class Author {
-List~Book~ books
}
class Translator {
-List~Book~ translatedBooks
}
Translator --|> Person : implements
Author --|> Person : implements
class Genre {
-int id
-String name
-List~Book~ books
}
class Library {
-int id
-User reader
-List~BookStatus~ bookStatuses
}
class BookStatus {
-int id
-Book book
-Status status
}
User "1" <--> "1" Library
Book "1" <--> "*" Library
Book "1" <--> "*" BookStatus
Book "*" --> "1" Genre
Book "*" --> "1" Author
Book "*" --> "1" Translator
Make sure you have the following installed:
- Java (version >= 21)
- MySQL Database
- Maven
git clone https://github.com/evagapi/great-reads.git
cd great-readsUsing Command Line
mvn installUsing IntelliJ IDEA
- Open IntelliJ IDEA.
- Open the great-reads project.
- Navigate to View > Tool Windows > Maven.
- Click on Reload All Maven Projects icon to update dependencies.
- Alternatively, right-click on pom.xml and select Reload Project.
Create a application-local.properties file and include the following properties matching your configuration:
spring.datasource.url=jdbc:mysql://localhost:[yourlocalhostport]/[yourdatabasename]?serverTimezone=UTC
spring.datasource.username=[youruser]
spring.datasource.password=[yourpassword]
The database will be automatically created the first time you run the application with the following configurations:
spring.profiles.active=local
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.hibernate.ddl-auto=create
spring.jpa.show-sql=trueAfter the first run, you need to update the spring.jpa.hibernate.ddl-auto to none to prevent data overwriting.
You can update spring.jpa.show-sql to false to disable SQL logging.
This project utilizes GitHub Actions for Continuous Integration (CI) with Maven. This GitHub Actions workflow is triggered on pull requests targeting the main branch. It sets up the required environment with JDK 21 and Maven. Then, it runs unit tests using Maven. This ensures that any code changes introduced via pull requests are tested automatically, providing quick feedback on the project's health and preventing bugs.
- Java 21
- Maven
- Spring Boot 3.2.4
- MySQL Database (development database)
- H2 Database (testing and GithubActions database)
- Spring Data JPA
- Spring Web
- Spring Security
- JWT (Java JSON Web Token)
- Lombok
- Spring Boot Starter Test
- Spring Boot Starter Validation
- JUnit Jupiter
You can access the API documentation through http://localhost:8080/swagger-ui/index.html/
- Ratings for Books
- Allow users to rate the books they read.
- Store and display individual user ratings for each book in the database.
- Calculate and display an average rating for each book based on the ratings provided by users.
- Provide sorting and filtering options to explore books based on their ratings.
- Social Features
- Allow users to connect with each other by adding friends.
- Enable users to make book recommendations to their added friends.