This project provides all the essential functionality for managing an online bookstore: from handling products to managing orders and user operations.
- ShoppingCart: A dedicated cart tied to each user for managing selected books.
- CartItem: Represents individual items in the shopping cart, including quantities and references to books.
- Order: Handles completed purchases, storing user details and a summary of items.
- OrderItem: Contains details of each book purchased as part of an order.
- Book: Represents the products available in the store, with attributes such as title, author, price, and description.
- Category: Organizes books into genres or thematic groups for easier navigation and filtering.
- User: Core entity for customer accounts, storing authentication details, personal information, and roles.
- Role: Manages access control with role-based permissions (e.g., ADMIN, USER).
- User registration with email and password.
- Secure user authentication and login (JWT-based).
- Role-based access control (Admin/User).
- Profile management (view and update user information).
- View a list of available books.
- Search books by title, author, or ISBN.
- Filter books by categories or genres.
- Sort books by price, popularity, or publication date.
- Detailed book pages with descriptions, reviews, and ratings.
- Add books to the shopping cart.
- Update the quantity of books in the cart.
- Remove items from the cart.
- View the total price of items in the cart.
- Checkout with a summary of items and total cost.
- View order history and statuses.
- Add, edit, or delete books from the catalog.
- Manage book categories and genres.
- Upload book cover images and multimedia content.
- Search functionality by author, category, price, and title.
- Secure password storage with encryption.
- Input validation and error handling.
- Java 17: The version of Java used for building and running the application, offering features like enhanced pattern matching, records, and improved performance.
- Spring Boot 3.3.4: Main framework for building the backend API with embedded Tomcat server support.
- MySQL: Relational database management system for storing application data.
- H2: In-memory database used for testing purposes.
- Liquibase: Database version control and schema management tool.
- Spring Security: Provides security services, including authentication and authorization, for the application.
- JWT (JSON Web Tokens): For secure user authentication using tokens.
- Spring Data JPA: Simplifies data access and integration with the database through JPA.
- Hibernate Validator: Used for validating Java beans based on constraints.
-
Checkstyle: Ensures code quality by enforcing a set of coding standards.
-
Lombok: Reduces boilerplate code with annotations like @Getter, @Setter, and @ToString.
-
MapStruct: Simplifies object mapping between Java beans.
-
JUnit 5: Framework for writing and running tests.
-
TestContainers: Provides lightweight, disposable containers for integration testing.
-
Spring Security Test: Tools for testing security aspects in Spring applications.
- Springdoc OpenAPI: Automatically generates OpenAPI documentation for RESTful APIs.
- Maven: Dependency management and build tool.
- Spring Boot Maven Plugin: For packaging the application into an executable JAR file.
- Docker Compose: Manages multi-container Docker applications, useful for local development and testing.
To install this project, you will need to have on your machine :
You can use any IDE (for example, IntelliJ IDEA) and run the following command in the terminal to clone the project
git clone https://github.com/ShastkivRuslan/online-book-shop.gitBuild application using Maven:
mvn clean packageCreate a .env file in the root of the project and configure the necessary environment variables, such as the database configuration:
MYSQLDB_DATABASE=your-db
MYSQLDB_USER=your-user-name
MYSQLDB_ROOT_PASSWORD=your-password
MYSQLDB_LOCAL_PORT=3308
MYSQLDB_DOCKER_PORT=3306
SPRING_LOCAL_PORT=8088
SPRING_DOCKER_PORT=8080
DEBUG_PORT=5005
Run the project using Docker Compose:
docker-compose up --buildOnce the project is running, it will be accessible at:
http://localhost:8088Swagger UI for API testing is available at:
http://localhost:8088/swagger-ui/To stop and remove the running Docker containers, use the command:
docker-compose down- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes and commit them.
- Submit a pull request.
- Email: shastkiv.ruslan.dev@gmail.com
- GitHub: https://github.com/ShastkivRuslan
- LinkedId: coming soon...